KDecoration2::DecorationButtonGroup Class Reference

#include <decorationbuttongroup.h>

Inheritance diagram for KDecoration2::DecorationButtonGroup:

Public Types
enum class	Position { Left , Right }
Public Types inherited from QObject
typedef	QObjectList

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 (Decoration *parent)
	DecorationButtonGroup (Position type, Decoration *parent, std::function< DecorationButton *(DecorationButtonType, Decoration *, QObject *)> buttonCreator)
void	addButton (DecorationButton *button)
QList< DecorationButton * >	buttons () const
Decoration *	decoration () const
QRectF	geometry () const
bool	hasButton (DecorationButtonType type) const
virtual void	paint (QPainter *painter, const QRect &repaintArea)
QPointF	pos () const
void	removeButton (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)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () 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 () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	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
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () 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 *context, Functor functor, 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)
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
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
QObject *	sender () 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 30 of file decorationbuttongroup.h.

Member Enumeration Documentation

Position

enum class KDecoration2::DecorationButtonGroup::Position

strong

Definition at line 51 of file decorationbuttongroup.h.

Property Documentation

geometry

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 42 of file decorationbuttongroup.h.

pos

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 49 of file decorationbuttongroup.h.

spacing

qreal KDecoration2::DecorationButtonGroup::spacing

readwrite

The spacing to use between the DecorationButtons.

Definition at line 36 of file decorationbuttongroup.h.

Constructor & Destructor Documentation

DecorationButtonGroup() [1/2]

KDecoration2::DecorationButtonGroup::DecorationButtonGroup ( DecorationButtonGroup::Position type, Decoration * parent, std::function< DecorationButton *(DecorationButtonType, Decoration *, QObject *)> buttonCreator )

explicit

Definition at line 101 of file decorationbuttongroup.cpp.

DecorationButtonGroup() [2/2]

KDecoration2::DecorationButtonGroup::DecorationButtonGroup ( Decoration * parent )

explicit

Definition at line 95 of file decorationbuttongroup.cpp.

Member Function Documentation

addButton()

void KDecoration2::DecorationButtonGroup::addButton

(

DecorationButton *

button

)

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

Definition at line 179 of file decorationbuttongroup.cpp.

buttons()

QList< DecorationButton * > KDecoration2::DecorationButtonGroup::buttons

(

)

const

Returns

All DecorationButtons in this DecorationButtonGroup

Definition at line 192 of file decorationbuttongroup.cpp.

decoration()

Decoration * KDecoration2::DecorationButtonGroup::decoration

(

)

const

Definition at line 131 of file decorationbuttongroup.cpp.

geometry()

QRectF KDecoration2::DecorationButtonGroup::geometry

(

)

const

Definition at line 136 of file decorationbuttongroup.cpp.

hasButton()

bool KDecoration2::DecorationButtonGroup::hasButton

(

DecorationButtonType

type

)

const

Returns

true if the DecorationButtonGroup contains a DecorationButton of type

Definition at line 141 of file decorationbuttongroup.cpp.

paint()

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

painter	The QPainter which is used to paint this DecorationButtonGroup
repaintArea	The area which is going to be repainted in Decoration coordinates

Definition at line 231 of file decorationbuttongroup.cpp.

pos()

QPointF KDecoration2::DecorationButtonGroup::pos

(

)

const

Definition at line 155 of file decorationbuttongroup.cpp.

removeButton() [1/2]

void KDecoration2::DecorationButtonGroup::removeButton

(

DecorationButton *

button

)

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

Definition at line 214 of file decorationbuttongroup.cpp.

removeButton() [2/2]

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 197 of file decorationbuttongroup.cpp.

setPos()

void KDecoration2::DecorationButtonGroup::setPos

(

const QPointF &

pos

)

Definition at line 160 of file decorationbuttongroup.cpp.

setSpacing()

void KDecoration2::DecorationButtonGroup::setSpacing

(

qreal

spacing

)

Definition at line 169 of file decorationbuttongroup.cpp.

spacing()

qreal KDecoration2::DecorationButtonGroup::spacing

(

)

const

Definition at line 150 of file decorationbuttongroup.cpp.

---

The documentation for this class was generated from the following files:

• decorationbuttongroup.h
• decorationbuttongroup.cpp