KDecoration2::DecorationButtonGroup

KDecoration2::DecorationButtonGroup Class Reference

#include <decorationbuttongroup.h>

Inheritance diagram for KDecoration2::DecorationButtonGroup:

Public Types

enum  Position { Left, Right }
 

Properties

QRectF geometry
 
QPointF pos
 
qreal spacing
 
- Properties inherited from QObject
 objectName
 

Signals

void geometryChanged (const QRectF &)
 
void posChanged (const QPointF &)
 
void spacingChanged (qreal)
 

Public Member Functions

 DecorationButtonGroup (Position type, Decoration *parent, std::function< DecorationButton *(DecorationButtonType, Decoration *, QObject *)> buttonCreator)
 
 DecorationButtonGroup (Decoration *parent)
 
void addButton (const QPointer< DecorationButton > &button)
 
QVector< QPointer< DecorationButton > > buttons () const
 
QPointer< Decorationdecoration () const
 
QRectF geometry () const
 
bool hasButton (DecorationButtonType type) const
 
virtual void paint (QPainter *painter, const QRect &repaintArea)
 
QPointF pos () const
 
void removeButton (const QPointer< DecorationButton > &button)
 
void removeButton (DecorationButtonType type)
 
void setPos (const QPointF &pos)
 
void setSpacing (qreal spacing)
 
qreal spacing () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Helper class to layout DecorationButton.

A Decoration normally has two groups of DecorationButtons: one left of the caption and one right of the caption. The DecorationButtonGroup helps in positioning the DecorationButtons in these groups and to update the position of each of the DecorationButtons whenever the state changes in a way that they should be repositioned.

A DecorationButtonGroup is a visual layout element not accepting input events. As a visual element it provides a paint method allowing a sub class to provide custom painting for the DecorationButtonGroup.

Definition at line 46 of file decorationbuttongroup.h.

Property Documentation

QRectF KDecoration2::DecorationButtonGroup::geometry
read

The geometry of the DecorationButtonGroup in Decoration-local coordinates.

The size of the DecorationButtonGroup depends on the sizes of the individual DecorationButtons and the spacing.

Definition at line 58 of file decorationbuttongroup.h.

QPointF KDecoration2::DecorationButtonGroup::pos
readwrite

The top left Position of the DecorationButtonGroup.

This property needs to be changed to reposition the DecorationButtonGroup. An update should normally be triggered after e.g. a state change like maximization.

Definition at line 65 of file decorationbuttongroup.h.

qreal KDecoration2::DecorationButtonGroup::spacing
readwrite

The spacing to use between the DecorationButtons.

Definition at line 52 of file decorationbuttongroup.h.

Member Function Documentation

void KDecoration2::DecorationButtonGroup::addButton ( const QPointer< DecorationButton > &  button)

Adds button to the DecorationButtonGroup and triggers a re-layout of all DecorationButtons.

Definition at line 173 of file decorationbuttongroup.cpp.

QVector< QPointer< DecorationButton > > KDecoration2::DecorationButtonGroup::buttons ( ) const
Returns
All DecorationButtons in this DecorationButtonGroup

Definition at line 182 of file decorationbuttongroup.cpp.

bool KDecoration2::DecorationButtonGroup::hasButton ( DecorationButtonType  type) const
Returns
true if the DecorationButtonGroup contains a DecorationButton of type

Definition at line 133 of file decorationbuttongroup.cpp.

void KDecoration2::DecorationButtonGroup::paint ( QPainter painter,
const QRect repaintArea 
)
virtual

Paints the DecorationButtonGroup.

This method should normally be invoked from the Decoration's paint method. Base implementation just calls the paint method on each of the DecorationButtons. Overwriting sub classes need to either call the base implementation or ensure that the DecorationButtons are painted.

Parameters
painterThe QPainter which is used to paint this DecorationButtonGroup
repaintAreaThe area which is going to be repainted in Decoration coordinates

Definition at line 221 of file decorationbuttongroup.cpp.

void KDecoration2::DecorationButtonGroup::removeButton ( const QPointer< DecorationButton > &  button)

Removes button from the DecorationButtonGroup and triggers a re-layout of all DecorationButtons.

Definition at line 204 of file decorationbuttongroup.cpp.

void KDecoration2::DecorationButtonGroup::removeButton ( DecorationButtonType  type)

Removes all DecorationButtons with type from the DecorationButtonGroup and triggers a re-layout of all DecorationButtons.

Definition at line 187 of file decorationbuttongroup.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Tue Aug 11 2020 23:09:37 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.