ToolBarLayout

#include <toolbarlayout.h>

Inheritance diagram for ToolBarLayout:

[legend]

Public Types
using	ActionsProperty = QQmlListProperty< QObject >

enum	HeightMode { AlwaysCenter, AlwaysFill, ConstrainIfLarger }

Public Types inherited from QQuickItem
enum	Flag

enum	ItemChange

enum	TransformOrigin

Properties
QQmlListProperty< QObject >	actions

Qt::Alignment	alignment

QQmlComponent	fullDelegate

HeightMode	heightMode

QList< QObject * >	hiddenActions

QQmlComponent	iconDelegate

Qt::LayoutDirection	layoutDirection

qreal	minimumWidth

QQmlComponent	moreButton

qreal	spacing

qreal	visibleWidth

Properties inherited from QQuickItem
	activeFocus

	activeFocusOnTab

	antialiasing

	baselineOffset

	childrenRect

	clip

	enabled

	focus

	height

	implicitHeight

	implicitWidth

	opacity

	parent

	rotation

	scale

	smooth

	state

	transformOrigin

	visible

	width

	x

	y

	z

Properties inherited from QObject
	objectName

Public Member Functions
	ToolBarLayout (QQuickItem *parent=nullptr)

Q_SIGNAL void	actionsChanged ()

ActionsProperty	actionsProperty () const

void	addAction (QObject *action)

Qt::Alignment	alignment () const

Q_SIGNAL void	alignmentChanged ()

void	clearActions ()

QQmlComponent *	fullDelegate () const

Q_SIGNAL void	fullDelegateChanged ()

HeightMode	heightMode () const

Q_SIGNAL void	heightModeChanged ()

QList< QObject * >	hiddenActions () const

Q_SIGNAL void	hiddenActionsChanged ()

QQmlComponent *	iconDelegate () const

Q_SIGNAL void	iconDelegateChanged ()

Qt::LayoutDirection	layoutDirection () const

Q_SIGNAL void	layoutDirectionChanged ()

qreal	minimumWidth () const

Q_SIGNAL void	minimumWidthChanged ()

QQmlComponent *	moreButton () const

Q_SIGNAL void	moreButtonChanged ()

Q_SLOT void	relayout ()

void	removeAction (QObject *action)

void	setAlignment (Qt::Alignment newAlignment)

void	setFullDelegate (QQmlComponent *newFullDelegate)

void	setHeightMode (HeightMode newHeightMode)

void	setIconDelegate (QQmlComponent *newIconDelegate)

void	setLayoutDirection (Qt::LayoutDirection &newLayoutDirection)

void	setMoreButton (QQmlComponent *newMoreButton)

void	setSpacing (qreal newSpacing)

qreal	spacing () const

Q_SIGNAL void	spacingChanged ()

qreal	visibleWidth () const

Q_SIGNAL void	visibleWidthChanged ()

Public Member Functions inherited from QQuickItem
	QQuickItem (QQuickItem *parent)

Qt::MouseButtons	acceptedMouseButtons () const const

bool	acceptHoverEvents () const const

bool	acceptTouchEvents () const const

void	activeFocusChanged (bool)

bool	activeFocusOnTab () const const

void	activeFocusOnTabChanged (bool)

bool	antialiasing () const const

void	antialiasingChanged (bool)

qreal	baselineOffset () const const

void	baselineOffsetChanged (qreal)

QQuickItem *	childAt (qreal x, qreal y) const const

QList< QQuickItem * >	childItems () const const

QRectF	childrenRect ()

void	childrenRectChanged (const QRectF &)

bool	clip () const const

void	clipChanged (bool)

QObject *	containmentMask () const const

void	containmentMaskChanged ()

virtual bool	contains (const QPointF &point) const const

QCursor	cursor () const const

void	enabledChanged ()

bool	filtersChildMouseEvents () const const

QQuickItem::Flags	flags () const const

void	focusChanged (bool)

void	forceActiveFocus ()

void	forceActiveFocus (Qt::FocusReason reason)

void	grabMouse ()

QSharedPointer< QQuickItemGrabResult >	grabToImage (const QSize &targetSize)

void	grabTouchPoints (const QVector< int > &ids)

bool	hasActiveFocus () const const

bool	hasFocus () const const

qreal	height () const const

void	heightChanged ()

qreal	implicitHeight () const const

void	implicitHeightChanged ()

qreal	implicitWidth () const const

void	implicitWidthChanged ()

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const const

bool	isAncestorOf (const QQuickItem *child) const const

bool	isEnabled () const const

bool	isFocusScope () const const

virtual bool	isTextureProvider () const const

bool	isVisible () const const

bool	keepMouseGrab () const const

bool	keepTouchGrab () const const

QPointF	mapFromGlobal (const QPointF &point) const const

QPointF	mapFromItem (const QQuickItem *item, const QPointF &point) const const

QPointF	mapFromScene (const QPointF &point) const const

QRectF	mapRectFromItem (const QQuickItem *item, const QRectF &rect) const const

QRectF	mapRectFromScene (const QRectF &rect) const const

QRectF	mapRectToItem (const QQuickItem *item, const QRectF &rect) const const

QRectF	mapRectToScene (const QRectF &rect) const const

QPointF	mapToGlobal (const QPointF &point) const const

QPointF	mapToItem (const QQuickItem *item, const QPointF &point) const const

QPointF	mapToScene (const QPointF &point) const const

QQuickItem *	nextItemInFocusChain (bool forward)

qreal	opacity () const const

void	opacityChanged ()

void	parentChanged (QQuickItem *)

QQuickItem *	parentItem () const const

void	polish ()

void	resetAntialiasing ()

void	resetHeight ()

void	resetWidth ()

qreal	rotation () const const

void	rotationChanged ()

qreal	scale () const const

void	scaleChanged ()

QQuickItem *	scopedFocusItem () const const

void	setAcceptedMouseButtons (Qt::MouseButtons buttons)

void	setAcceptHoverEvents (bool enabled)

void	setAcceptTouchEvents (bool enabled)

void	setActiveFocusOnTab (bool)

void	setAntialiasing (bool)

void	setBaselineOffset (qreal)

void	setClip (bool)

void	setContainmentMask (QObject *mask)

void	setCursor (const QCursor &cursor)

void	setEnabled (bool)

void	setFiltersChildMouseEvents (bool filter)

void	setFlag (QQuickItem::Flag flag, bool enabled)

void	setFlags (QQuickItem::Flags flags)

void	setFocus (bool focus, Qt::FocusReason reason)

void	setFocus (bool)

void	setHeight (qreal)

void	setImplicitHeight (qreal)

void	setImplicitWidth (qreal)

void	setKeepMouseGrab (bool keep)

void	setKeepTouchGrab (bool keep)

void	setOpacity (qreal)

void	setParentItem (QQuickItem *parent)

void	setRotation (qreal)

void	setScale (qreal)

void	setSize (const QSizeF &size)

void	setSmooth (bool)

void	setState (const QString &)

void	setTransformOrigin (QQuickItem::TransformOrigin)

void	setVisible (bool)

void	setWidth (qreal)

void	setX (qreal)

void	setY (qreal)

void	setZ (qreal)

QSizeF	size () const const

bool	smooth () const const

void	smoothChanged (bool)

void	stackAfter (const QQuickItem *sibling)

void	stackBefore (const QQuickItem *sibling)

QString	state () const const

void	stateChanged (const QString &)

virtual QSGTextureProvider *	textureProvider () const const

QQuickItem::TransformOrigin	transformOrigin () const const

void	transformOriginChanged (QQuickItem::TransformOrigin)

void	ungrabMouse ()

void	ungrabTouchPoints ()

void	unsetCursor ()

void	update ()

void	visibleChanged ()

qreal	width () const const

void	widthChanged ()

QQuickWindow *	window () const const

void	windowChanged (QQuickWindow *window)

qreal	x () const const

void	xChanged ()

qreal	y () const const

void	yChanged ()

qreal	z () const const

void	zChanged ()

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	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

Static Public Member Functions
static ToolBarLayoutAttached *	qmlAttachedProperties (QObject *object)

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)

Protected Member Functions
void	componentComplete () override

void	geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) override

void	itemChange (QQuickItem::ItemChange change, const QQuickItem::ItemChangeData &data) override

void	updatePolish () override

Protected Member Functions inherited from QQuickItem
virtual bool	childMouseEventFilter (QQuickItem item, QEvent event)

virtual void	classBegin () override

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual bool	event (QEvent *ev) override

virtual void	focusInEvent (QFocusEvent *)

virtual void	focusOutEvent (QFocusEvent *)

virtual void	geometryChanged (const QRectF &newGeometry, const QRectF &oldGeometry)

bool	heightValid () const const

virtual void	hoverEnterEvent (QHoverEvent *event)

virtual void	hoverLeaveEvent (QHoverEvent *event)

virtual void	hoverMoveEvent (QHoverEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

bool	isComponentComplete () const const

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	mouseUngrabEvent ()

virtual void	releaseResources ()

virtual void	touchEvent (QTouchEvent *event)

virtual void	touchUngrabEvent ()

void	updateInputMethod (Qt::InputMethodQueries queries)

virtual QSGNode *	updatePaintNode (QSGNode oldNode, QQuickItem::UpdatePaintNodeData updatePaintNodeData)

virtual void	wheelEvent (QWheelEvent *event)

bool	widthValid () const const

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)

Additional Inherited Members
Public Attributes inherited from QQuickItem
	Bottom

	BottomLeft

	BottomRight

	Center

typedef	Flags

	ItemAcceptsDrops

	ItemAcceptsInputMethod

	ItemActiveFocusHasChanged

	ItemAntialiasingHasChanged

	ItemChildAddedChange

	ItemChildRemovedChange

	ItemClipsChildrenToShape

	ItemDevicePixelRatioHasChanged

	ItemEnabledHasChanged

	ItemHasContents

	ItemIsFocusScope

	ItemOpacityHasChanged

	ItemParentHasChanged

	ItemRotationHasChanged

	ItemSceneChange

	ItemVisibleHasChanged

	Left

	Right

	Top

	TopLeft

	TopRight

Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

This is a layout that creates delegates for actions and lays them out in a row.

This effectively combines QtQuick.Layouts.RowLayout and QtQuick.Repeater in a single item, with the addition of some extra performance enhancing tweaks. It will create instances of ::fullDelegate and ::iconDelegate for each action in ::actions. These are then positioned horizontally. Any action that ends up being placed outside the width of the item is hidden and will be part of ::hiddenActions which are shown in a overflow menu.

The items created as delegates are always created asynchronously, to avoid creation lag spikes. Each delegate has access to the action it was created for through the ToolBarLayoutAttached attached property.

Definition at line 47 of file toolbarlayout.h.

Member Enumeration Documentation

◆ HeightMode

enum ToolBarLayout::HeightMode

This enum describes several modes that can be used to deal with items with height that does not match the toolbar's height.

Enumerator

Enumerator
AlwaysCenter	Always center items, allowing them to go outside the bounds of the layout if they are larger.
AlwaysFill	Always match the height of the layout. Larger items will be reduced in height, smaller items will be increased.
ConstrainIfLarger	If the item is larger than the toolbar, reduce its height. Otherwise center it in the toolbar.

AlwaysCenter

Always center items, allowing them to go outside the bounds of the layout if they are larger.

AlwaysFill

Always match the height of the layout.

Larger items will be reduced in height, smaller items will be increased.

ConstrainIfLarger

If the item is larger than the toolbar, reduce its height.

Otherwise center it in the toolbar.

Definition at line 149 of file toolbarlayout.h.

Property Documentation

◆ actions

QQmlListProperty<QObject> ToolBarLayout::actions

read

This property holds a list of visible actions this layout should create delegates for.

Definition at line 53 of file toolbarlayout.h.

◆ alignment

Qt::Alignment ToolBarLayout::alignment

readwrite

This property sets how to align the delegates within this layout.

When there is more space available than required by the visible delegates, we need to determine how to place the delegates. This property determines how to do that.

Note: The ::moreButton, if visible, will always be placed at the end of the layout.

See also: Qt::Alignment

Definition at line 105 of file toolbarlayout.h.

◆ fullDelegate

QQmlComponent * ToolBarLayout::fullDelegate

readwrite

This property holds a component that is used to create full-size delegates.

Each delegate has three states, it can be full-size, icon-only or hidden. By default, the full-size delegate is used.

The full-size delegate is used when the action has its display hint set to KeepVisible . If there is not enough space, it will either use iconDelegate or the delegate will be shown in the overflow menu.

See also: org::kde::kirigami::Action::displayComponent

Definition at line 72 of file toolbarlayout.h.

◆ heightMode

ToolBarLayout::HeightMode ToolBarLayout::heightMode

readwrite

This property sets how to handle items that do not match the toolbar's height.

When toolbar items do not match the height of the toolbar, there are several ways we can deal with this. This property sets the preferred way.

default: ToolBarLayout.HeightMode.ConstrainIfLarger

See also: ::HeightMode

Definition at line 140 of file toolbarlayout.h.

◆ hiddenActions

QList< QObject * > ToolBarLayout::hiddenActions

read

This property holds a list of hidden actions that do not fit in the current view, and are thus hidden.

Definition at line 58 of file toolbarlayout.h.

◆ iconDelegate

QQmlComponent * ToolBarLayout::iconDelegate

readwrite

This property holds a component that is used to create icon-only delegates.

This is used when display hint is set to IconOnly , unless there is not enough space, in which case it will show the delegate in the overflow menu.

See also: ::fullDelegate

Definition at line 82 of file toolbarlayout.h.

◆ layoutDirection

Qt::LayoutDirection ToolBarLayout::layoutDirection

readwrite

This property sets the layout direction of the toolbar layout.

This is primarily intended to support right-to-left layouts. When set to LeftToRight, delegates will be layout with the first item on the left and following items to the right of that. The more button will be placed at the rightmost position. Alignment flags work normally.

When set to RightToLeft, delegates will be layout with the first item on the right and following items to the left of that. The more button will be placed at the leftmost position. Alignment flags are inverted, so AlignLeft will align items to the right, and vice-versa.

Definition at line 129 of file toolbarlayout.h.

◆ minimumWidth

qreal ToolBarLayout::minimumWidth

read

This property holds the minimum width this layout can have.

This is equal to the width of the ::moreButton.

Definition at line 115 of file toolbarlayout.h.

◆ moreButton

QQmlComponent * ToolBarLayout::moreButton

readwrite

This property holds a component that is used to create the "more button" item from.

The more button is shown when there are actions that do not fit the current view. It is intended to have functionality to show these hidden actions, like popup a menu with them showing.

Definition at line 90 of file toolbarlayout.h.

◆ spacing

qreal ToolBarLayout::spacing

readwrite

This property holds the amount of spacing between individual delegates.

Definition at line 94 of file toolbarlayout.h.

◆ visibleWidth

qreal ToolBarLayout::visibleWidth

read

This property holds the combined width of visible delegates in this layout.

Definition at line 109 of file toolbarlayout.h.

Member Function Documentation

◆ addAction()

void ToolBarLayout::addAction ( QObject * action )

This method adds an action to the list of actions.

Parameters

action The action to add.

Definition at line 120 of file toolbarlayout.cpp.

◆ clearActions()

void ToolBarLayout::clearActions ( )

This method clears the list of actions.

Definition at line 158 of file toolbarlayout.cpp.

◆ relayout()

void ToolBarLayout::relayout ( )

This slot queues a relayout of this ToolBarLayout.

Note: The layouting happens during the next scene graph polishing phase.

Definition at line 307 of file toolbarlayout.cpp.

◆ removeAction()

void ToolBarLayout::removeAction ( QObject * action )

This method removes an action from the list of actions.

Parameters

action The action to remove.

Definition at line 143 of file toolbarlayout.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Kirigami2

ToolBarLayout

Public Types

Properties

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ HeightMode

Property Documentation

◆ actions

◆ alignment

◆ fullDelegate

◆ heightMode

◆ hiddenActions

◆ iconDelegate

◆ layoutDirection

◆ minimumWidth

◆ moreButton

◆ spacing

◆ visibleWidth

Member Function Documentation

◆ addAction()

◆ clearActions()

◆ relayout()

◆ removeAction()