SizeGroup Class Reference

#include <sizegroup.h>

Inheritance diagram for SizeGroup:

Public Types
enum	Mode { None = 0, Width = 1, Height = 2, Both = 3 }
typedef QFlags< Mode >	Modes

Properties
QQmlListProperty< QQuickItem >	items
Mode	mode
Properties inherited from QObject
	objectName

Public Member Functions
void	adjustItems (Mode whatChanged)
void	classBegin () override
void	componentComplete () override
void	connectItem (QQuickItem *item)
QQmlListProperty< QQuickItem >	items ()
Q_SIGNAL void	modeChanged ()
Q_INVOKABLE void	relayout ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
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 ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
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 QRegExp &regExp, 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
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 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_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
T	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)
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	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)
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)
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
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

SizeGroup is a utility object that makes groups of items request the same size.

This can be instantiated to automatically manage the height, width, or both sizes of multiple items based on the item with the highest value. In other words, if widths are synchronized, all items being managed by a SizeGroup will have the same preferredWidth as the item with the largest implicitWidth.

Pass a JavaScript array of ::items to be managed by this object, then set the ::mode property to define which size to synchronize.

Note

Manually setting a width or height for items managed by a SizeGroup will override the width or height calculated by the instantiated SizeGroup.

All objects managed by a SizeGroup must belong to a Layout. This includes Kirigami-specific Layouts such as org::kde::kirigami::FormLayout.

import QtQuick 2.15
import QtQuick.Layouts 1.15
import QtQuick.Controls 2.15 as Controls
import org.kde.kirigami 2.20 as Kirigami
 
Kirigami.ApplicationWindow {
    pageStack.initialPage: Kirigami.Page {
        Kirigami.SizeGroup {
            items: [rect1, rect2, rect3]
            mode: Kirigami.SizeGroup.Width
        }
        RowLayout {
            id: layout
            anchors.fill: parent
 
            Rectangle {
                id: rect1
                color: "red"
                height: 100
                width: 400
            }
            Rectangle {
                id: rect2
                color: "green"
                height: 100
                implicitWidth: 150
            }
            Rectangle {
                id: rect3
                color: "blue"
                height: 100
                implicitWidth: 200
            }
        }
    }
}

Definition at line 37 of file sizegroup.h.

Member Enumeration Documentation

Mode

enum SizeGroup::Mode

Enumerator
None	SizeGroup does nothing.
Width	SizeGroup syncs item widths.
Height	SizeGroup syncs item heights.
Both	SizeGroup syncs both item widths and heights.

Definition at line 43 of file sizegroup.h.

Property Documentation

items

QQmlListProperty< QQuickItem > SizeGroup::items

read

This property holds a list of items this SizeGroup should adjust.

Definition at line 82 of file sizegroup.h.

mode

Mode SizeGroup::mode

This property sets which dimensions this SizeGroup should sync.

Definition at line 76 of file sizegroup.h.

Member Function Documentation

relayout()

void SizeGroup::relayout

(

)

This method forces the SizeGroup to relayout its items.

Normally this is never needed as the SizeGroup automatically relayouts items as they're added and their sizes change.

Definition at line 68 of file sizegroup.cpp.

---

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

• sizegroup.h
• sizegroup.cpp