#include <qquicklayout_p.h>

Inheritance diagram for QQuickLayout:

Collaboration diagram for QQuickLayout:

Public Types
enum	SizeHint { MinimumSize = 0 , PreferredSize , MaximumSize , NSizes }
enum	EnsureLayoutItemsUpdatedOption { Recursive = 0b001 , ApplySizeHints = 0b010 }
enum	SizePolicy { SizePolicyImplicit = 1 , SizePolicyExplicit }
Public Types inherited from QQuickItem
enum	Flag { ItemClipsChildrenToShape = 0x01 , ItemIsFocusScope = 0x04 , ItemHasContents = 0x08 , ItemAcceptsDrops = 0x10 , ItemIsViewport = 0x20 , ItemObservesViewport = 0x40 }
	\qmltype Item \nativetype QQuickItem \inherits QtObject \inqmlmodule QtQuick More...
enum	ItemChange { ItemChildAddedChange , ItemChildRemovedChange , ItemSceneChange , ItemVisibleHasChanged , ItemParentHasChanged , ItemOpacityHasChanged , ItemActiveFocusHasChanged , ItemRotationHasChanged , ItemAntialiasingHasChanged , ItemDevicePixelRatioHasChanged , ItemEnabledHasChanged , ItemScaleHasChanged , ItemTransformHasChanged }
	Used in conjunction with QQuickItem::itemChange() to notify the item about certain types of changes. More...
enum	TransformOrigin { TopLeft , Top , TopRight , Left , Center , Right , BottomLeft , Bottom , BottomRight }
	\variable QQuickItem::ItemChangeData::realValue The numeric value that has changed: \l {QQuickItem::opacity()}{opacity}, \l {QQuickItem::rotation()}{rotation}, or \l {QQuickItem::scale()}{scale}, or \l {QScreen::devicePixelRatio}{device pixel ratio}. More...

Public Member Functions
	QQuickLayout (QQuickLayoutPrivate &dd, QQuickItem *parent=nullptr)
	~QQuickLayout ()
void	componentComplete () override
	\reimp Derived classes should call the base class method before adding their own actions to perform at componentComplete.
virtual QSizeF	sizeHint (Qt::SizeHint whichSizeHint) const =0
virtual void	setAlignment (QQuickItem *item, Qt::Alignment align)=0
virtual void	setStretchFactor (QQuickItem *item, int stretchFactor, Qt::Orientation orient)=0
virtual void	invalidate (QQuickItem *childItem=nullptr)
virtual void	updateLayoutItems ()=0
void	ensureLayoutItemsUpdated (EnsureLayoutItemsUpdatedOptions options={}) const
virtual QQuickItem *	itemAt (int index) const =0
virtual int	itemCount () const =0
virtual void	rearrange (const QSizeF &)
bool	shouldIgnoreItem (QQuickItem *child) const
void	checkAnchors (QQuickItem *item) const
void	itemChange (ItemChange change, const ItemChangeData &value) override
	Called when change occurs for this item.
void	geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) override
bool	isReady () const
void	deactivateRecur ()
	QQuickLayout::deactivateRecur.
bool	invalidated () const
bool	invalidatedArrangement () const
bool	isMirrored () const
void	itemSiblingOrderChanged (QQuickItem *item) override
void	itemImplicitWidthChanged (QQuickItem *item) override
void	itemImplicitHeightChanged (QQuickItem *item) override
void	itemDestroyed (QQuickItem *item) override
void	itemVisibilityChanged (QQuickItem *item) override
void	maybeSubscribeToBaseLineOffsetChanges (QQuickItem *item)
Q_INVOKABLE void	_q_dumpLayoutTree () const
void	dumpLayoutTreeRecursive (int level, QString &buf) const
Public Member Functions inherited from QQuickItem
	QQuickItem (QQuickItem *parent=nullptr)
	Constructs a QQuickItem with the given parent.
	~QQuickItem () override
	Destroys the QQuickItem.
QQuickWindow *	window () const
	Returns the window in which this item is rendered.
QQuickItem *	parentItem () const
void	setParentItem (QQuickItem *parent)
void	stackBefore (const QQuickItem *)
	Moves this item to the index before the specified sibling item within the list of children.
void	stackAfter (const QQuickItem *)
	Moves this item to the index after the specified sibling item within the list of children.
QRectF	childrenRect ()
	\qmlpropertygroup QtQuick::Item::childrenRect \qmlproperty real QtQuick::Item::childrenRect.x \qmlproperty real QtQuick::Item::childrenRect.y \qmlproperty real QtQuick::Item::childrenRect.width \qmlproperty real QtQuick::Item::childrenRect.height \readonly
QList< QQuickItem * >	childItems () const
	Returns the children of this item.
bool	clip () const
	\qmlproperty bool QtQuick::Item::clip This property holds whether clipping is enabled.
void	setClip (bool)
QString	state () const
	\qmlproperty string QtQuick::Item::state
void	setState (const QString &)
qreal	baselineOffset () const
	\qmlproperty int QtQuick::Item::baselineOffset
void	setBaselineOffset (qreal)
QQmlListProperty< QQuickTransform >	transform ()
qreal	x () const
qreal	y () const
QPointF	position () const
void	setX (qreal)
void	setY (qreal)
void	setPosition (const QPointF &)
QBindable< qreal >	bindableX ()
QBindable< qreal >	bindableY ()
qreal	width () const
void	setWidth (qreal)
void	resetWidth ()
void	setImplicitWidth (qreal)
qreal	implicitWidth () const
	Returns the width of the item that is implied by other properties that determine the content.
QBindable< qreal >	bindableWidth ()
qreal	height () const
void	setHeight (qreal)
void	resetHeight ()
void	setImplicitHeight (qreal)
qreal	implicitHeight () const
QBindable< qreal >	bindableHeight ()
QSizeF	size () const
void	setSize (const QSizeF &size)
TransformOrigin	transformOrigin () const
void	setTransformOrigin (TransformOrigin)
QPointF	transformOriginPoint () const
void	setTransformOriginPoint (const QPointF &)
qreal	z () const
void	setZ (qreal)
qreal	rotation () const
void	setRotation (qreal)
qreal	scale () const
void	setScale (qreal)
qreal	opacity () const
void	setOpacity (qreal)
bool	isVisible () const
void	setVisible (bool)
bool	isEnabled () const
void	setEnabled (bool)
bool	smooth () const
void	setSmooth (bool)
bool	activeFocusOnTab () const
	\qmlproperty bool QtQuick::Item::activeFocusOnTab
void	setActiveFocusOnTab (bool)
bool	antialiasing () const
void	setAntialiasing (bool)
void	resetAntialiasing ()
Flags	flags () const
	Returns the item flags for this item.
void	setFlag (Flag flag, bool enabled=true)
	Enables the specified flag for this item if enabled is true; if enabled is false, the flag is disabled.
void	setFlags (Flags flags)
	Enables the specified flags for this item.
virtual QRectF	boundingRect () const
	Returns the extents of the item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().
virtual QRectF	clipRect () const
	Returns the rectangular area within this item that is currently visible in \l viewportItem(), if there is a viewport and the \l ItemObservesViewport flag is set; otherwise, the extents of this item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().
QQuickItem *	viewportItem () const
	If the \l ItemObservesViewport flag is set, returns the nearest parent with the \l ItemIsViewport flag.
bool	hasActiveFocus () const
bool	hasFocus () const
void	setFocus (bool)
void	setFocus (bool focus, Qt::FocusReason reason)
bool	isFocusScope () const
	Returns true if this item is a focus scope, and false otherwise.
QQuickItem *	scopedFocusItem () const
	If this item is a focus scope, this returns the item in its focus chain that currently has focus.
Qt::FocusPolicy	focusPolicy () const
void	setFocusPolicy (Qt::FocusPolicy policy)
	Sets the focus policy of this item to policy.
bool	isAncestorOf (const QQuickItem *child) const
	Returns `true` if this item is an ancestor of child (i.e., if this item is child's parent, or one of child's parent's ancestors).
Qt::MouseButtons	acceptedMouseButtons () const
	Returns the mouse buttons accepted by this item.
void	setAcceptedMouseButtons (Qt::MouseButtons buttons)
	Sets the mouse buttons accepted by this item to buttons.
bool	acceptHoverEvents () const
	Returns whether hover events are accepted by this item.
void	setAcceptHoverEvents (bool enabled)
	If enabled is true, this sets the item to accept hover events; otherwise, hover events are not accepted by this item.
bool	acceptTouchEvents () const
	Returns whether touch events are accepted by this item.
void	setAcceptTouchEvents (bool accept)
	If enabled is true, this sets the item to accept touch events; otherwise, touch events are not accepted by this item.
bool	isUnderMouse () const
void	grabMouse ()
void	ungrabMouse ()
bool	keepMouseGrab () const
	Returns whether mouse input should exclusively remain with this item.
void	setKeepMouseGrab (bool)
	Sets whether the mouse input should remain exclusively with this item.
bool	filtersChildMouseEvents () const
	Returns whether pointer events intended for this item's children should be filtered through this item.
void	setFiltersChildMouseEvents (bool filter)
	Sets whether pointer events intended for this item's children should be filtered through this item.
void	grabTouchPoints (const QList< int > &ids)
void	ungrabTouchPoints ()
bool	keepTouchGrab () const
	Returns whether the touch points grabbed by this item should exclusively remain with this item.
void	setKeepTouchGrab (bool)
	Sets whether the touch points grabbed by this item should remain exclusively with this item.
	Q_REVISION (2, 4) Q_INVOKABLE bool grabToImage(const QJSValue &callback
QSharedPointer< QQuickItemGrabResult >	grabToImage (const QSize &targetSize=QSize())
	Grabs the item into an in-memory image.
virtual Q_INVOKABLE bool	contains (const QPointF &point) const
	\qmlmethod bool QtQuick::Item::contains(point point)
QObject *	containmentMask () const
void	setContainmentMask (QObject *mask)
QTransform	itemTransform (QQuickItem , bool ) const
	\qmlmethod point QtQuick::Item::mapFromItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapFromItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, rect r)
QPointF	mapToScene (const QPointF &point) const
	Maps the given point in this item's coordinate system to the equivalent point within the scene's coordinate system, and returns the mapped coordinate.
QRectF	mapRectToItem (const QQuickItem *item, const QRectF &rect) const
	Maps the given rect in this item's coordinate system to the equivalent rectangular area within item's coordinate system, and returns the mapped rectangle value.
QRectF	mapRectToScene (const QRectF &rect) const
	Maps the given rect in this item's coordinate system to the equivalent rectangular area within the scene's coordinate system, and returns the mapped rectangle value.
QPointF	mapFromScene (const QPointF &point) const
	Maps the given point in the scene's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate.
QRectF	mapRectFromItem (const QQuickItem *item, const QRectF &rect) const
	Maps the given rect in item's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value.
QRectF	mapRectFromScene (const QRectF &rect) const
	Maps the given rect in the scene's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value.
void	polish ()
	Schedules a polish event for this item.
Q_INVOKABLE QPointF	mapFromItem (const QQuickItem *item, const QPointF &point) const
	Maps the given point in item's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate.
Q_INVOKABLE QPointF	mapFromItem (const QQuickItem *item, qreal x, qreal y)
Q_INVOKABLE QRectF	mapFromItem (const QQuickItem *item, const QRectF &rect) const
Q_INVOKABLE QRectF	mapFromItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const
Q_INVOKABLE QPointF	mapToItem (const QQuickItem *item, const QPointF &point) const
	Maps the given point in this item's coordinate system to the equivalent point within item's coordinate system, and returns the mapped coordinate.
Q_INVOKABLE QPointF	mapToItem (const QQuickItem *item, qreal x, qreal y)
Q_INVOKABLE QRectF	mapToItem (const QQuickItem *item, const QRectF &rect) const
Q_INVOKABLE QRectF	mapToItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const
	Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(qreal x
	Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(const QPointF &point) const
	Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(qreal x
	Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(const QPointF &point) const
Q_INVOKABLE void	forceActiveFocus ()
	\qmlmethod point QtQuick::Item::mapToItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapToItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapToItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapToItem(Item item, rect r)
Q_INVOKABLE void	forceActiveFocus (Qt::FocusReason reason)
	\qmlmethod QtQuick::Item::forceActiveFocus(Qt::FocusReason reason) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Forces active focus on the item with the given reason.
	Q_REVISION (2, 1) Q_INVOKABLE QQuickItem *nextItemInFocusChain(bool forward
Q_INVOKABLE QQuickItem *	childAt (qreal x, qreal y) const
	\qmlmethod Item QtQuick::Item::childAt(real x, real y)
	Q_REVISION (6, 3) Q_INVOKABLE void ensurePolished()
	Q_REVISION (6, 3) Q_INVOKABLE void dumpItemTree() const
virtual bool	isTextureProvider () const
	Returns true if this item is a texture provider.
virtual QSGTextureProvider *	textureProvider () const
	Returns the texture provider for an item.
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.
bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.
bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.
bool	isQmlObjectType () const
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject receiver, const char member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.
Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()
virtual	~QQmlParserStatus ()
Public Member Functions inherited from QQuickItemChangeListener
virtual	~QQuickItemChangeListener ()
virtual void	itemGeometryChanged (QQuickItem *, QQuickGeometryChange, const QRectF &)
virtual void	itemEnabledChanged (QQuickItem *)
virtual void	itemOpacityChanged (QQuickItem *)
virtual void	itemChildAdded (QQuickItem , QQuickItem )
virtual void	itemChildRemoved (QQuickItem , QQuickItem )
virtual void	itemParentChanged (QQuickItem , QQuickItem )
virtual void	itemRotationChanged (QQuickItem *)
virtual void	itemFocusChanged (QQuickItem *, Qt::FocusReason)
virtual void	itemScaleChanged (QQuickItem *)
virtual void	itemTransformChanged (QQuickItem , QQuickItem )
virtual QQuickAnchorsPrivate *	anchorPrivate ()
virtual bool	baseDeleted (const QObject *caller) const
virtual QString	debugName () const
virtual void	addSourceItem (QQuickItem *)
virtual void	removeSourceItem (QQuickItem *)

Static Public Member Functions
static QQuickLayoutAttached *	qmlAttachedProperties (QObject *object)
static void	effectiveSizeHints_helper (QQuickItem item, QSizeF cachedSizeHints, QQuickLayoutAttached **info, bool useFallbackToWidthOrHeight)
static QLayoutPolicy::Policy	effectiveSizePolicy_helper (QQuickItem item, Qt::Orientation orientation, QQuickLayoutAttached info)
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe
static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.
template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)
template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Types
enum	Orientation { Vertical = 0 , Horizontal , NOrientations }

Protected Slots
void	invalidateSenderItem ()

Protected Member Functions
void	updatePolish () override
	This function should perform any layout as required for this item.
Protected Member Functions inherited from QQuickItem
bool	event (QEvent *) override
	\reimp
bool	isComponentComplete () const
	Returns true if construction of the QML component is complete; otherwise returns false.
bool	widthValid () const
	Returns whether the width property has been set explicitly.
bool	heightValid () const
	Returns whether the height property has been set explicitly.
void	setImplicitSize (qreal, qreal)
void	classBegin () override
	\reimp Derived classes should call the base class method before adding their own action to perform at classBegin.
virtual void	keyPressEvent (QKeyEvent *event)
	This event handler can be reimplemented in a subclass to receive key press events for an item.
virtual void	keyReleaseEvent (QKeyEvent *event)
	This event handler can be reimplemented in a subclass to receive key release events for an item.
virtual void	focusInEvent (QFocusEvent *)
	This event handler can be reimplemented in a subclass to receive focus-in events for an item.
virtual void	focusOutEvent (QFocusEvent *)
	This event handler can be reimplemented in a subclass to receive focus-out events for an item.
virtual void	mousePressEvent (QMouseEvent *event)
	This event handler can be reimplemented in a subclass to receive mouse press events for an item.
virtual void	mouseMoveEvent (QMouseEvent *event)
	This event handler can be reimplemented in a subclass to receive mouse move events for an item.
virtual void	mouseReleaseEvent (QMouseEvent *event)
	This event handler can be reimplemented in a subclass to receive mouse release events for an item.
virtual void	mouseDoubleClickEvent (QMouseEvent *event)
	This event handler can be reimplemented in a subclass to receive mouse double-click events for an item.
virtual void	mouseUngrabEvent ()
	This event handler can be reimplemented in a subclass to be notified when a mouse ungrab event has occurred on this item.
virtual void	touchUngrabEvent ()
	This event handler can be reimplemented in a subclass to be notified when a touch ungrab event has occurred on this item.
virtual void	touchEvent (QTouchEvent *event)
	This event handler can be reimplemented in a subclass to receive touch events for an item.
virtual void	hoverEnterEvent (QHoverEvent *event)
	This event handler can be reimplemented in a subclass to receive hover-enter events for an item.
virtual void	hoverMoveEvent (QHoverEvent *event)
	This event handler can be reimplemented in a subclass to receive hover-move events for an item.
virtual void	hoverLeaveEvent (QHoverEvent *event)
	This event handler can be reimplemented in a subclass to receive hover-leave events for an item.
virtual bool	childMouseEventFilter (QQuickItem , QEvent )
	Reimplement this method to filter the pointer events that are received by this item's children.
virtual bool	contextMenuEvent (QContextMenuEvent *event)
virtual QSGNode *	updatePaintNode (QSGNode , UpdatePaintNodeData )
	Called on the render thread when it is time to sync the state of the item with the scene graph.
virtual void	releaseResources ()
	This function is called when an item should release graphics resources which are not already managed by the nodes returned from QQuickItem::updatePaintNode().
	QQuickItem (QQuickItemPrivate &dd, QQuickItem *parent=nullptr)
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Friends
class	QQuickLayoutAttached

Additional Inherited Members
Public Slots inherited from QQuickItem
void	update ()
	Schedules a call to updatePaintNode() for this item.
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Signals inherited from QQuickItem
void	childrenRectChanged (const QRectF &)
void	baselineOffsetChanged (qreal)
void	stateChanged (const QString &)
void	focusChanged (bool)
void	activeFocusChanged (bool)
Q_REVISION(6, 7) void focusPolicyChanged(Qt	Q_REVISION (2, 1) void activeFocusOnTabChanged(bool)
void	parentChanged (QQuickItem *)
void	transformOriginChanged (TransformOrigin)
void	smoothChanged (bool)
void	antialiasingChanged (bool)
void	clipChanged (bool)
	Q_REVISION (2, 1) void windowChanged(QQuickWindow *window)
void	childrenChanged ()
void	opacityChanged ()
void	enabledChanged ()
void	visibleChanged ()
void	visibleChildrenChanged ()
void	rotationChanged ()
void	scaleChanged ()
void	xChanged ()
void	yChanged ()
void	widthChanged ()
void	heightChanged ()
void	zChanged ()
void	implicitWidthChanged ()
void	implicitHeightChanged ()
	Q_REVISION (2, 11) void containmentMaskChanged()
	Q_REVISION (6, 0) void paletteChanged()
	Q_REVISION (6, 0) void paletteCreated()
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.
Public Attributes inherited from QQuickItem
const QSize &	targetSize = QSize())
qreal y	const
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Properties inherited from QQuickItem
QQuickItem *	parent
	\qmlproperty Item QtQuick::Item::parent This property holds the visual parent of the item.
qreal	x
	\qmlproperty real QtQuick::Item::x \qmlproperty real QtQuick::Item::y \qmlproperty real QtQuick::Item::width \qmlproperty real QtQuick::Item::height
qreal	y
	Defines the item's y position relative to its parent.
qreal	z
	\qmlproperty real QtQuick::Item::z
qreal	width
	This property holds the width of this item.
qreal	height
	This property holds the height of this item.
qreal	opacity
	\qmlproperty real QtQuick::Item::opacity
bool	enabled
	\qmlproperty bool QtQuick::Item::enabled
bool	visible
	\qmlproperty bool QtQuick::Item::visible
Qt::FocusPolicy	focusPolicy
	\qmlproperty enumeration QtQuick::Item::focusPolicy
qreal	rotation
	\qmlproperty real QtQuick::Item::rotation This property holds the rotation of the item in degrees clockwise around its transformOrigin.
qreal	scale
	\qmlproperty real QtQuick::Item::scale This property holds the scale factor for this item.
TransformOrigin	transformOrigin
	\qmlproperty enumeration QtQuick::Item::transformOrigin This property holds the origin point around which scale and rotation transform.
QPointF	transformOriginPoint
QQmlListProperty< QQuickTransform >	transform
	\qmlproperty list<Transform> QtQuick::Item::transform
bool	smooth
	\qmlproperty bool QtQuick::Item::smooth
bool	antialiasing
	\qmlproperty bool QtQuick::Item::antialiasing
qreal	implicitWidth
qreal	implicitHeight
QObject *	containmentMask
	\qmlproperty QObject* QtQuick::Item::containmentMask
Properties inherited from QObject
QString	objectName
	the name of this object
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 35 of file qquicklayout_p.h.

Member Enumeration Documentation

◆ EnsureLayoutItemsUpdatedOption

enum QQuickLayout::EnsureLayoutItemsUpdatedOption

Enumerator
Recursive
ApplySizeHints

Definition at line 52 of file qquicklayout_p.h.

◆ Orientation

enum QQuickLayout::Orientation

protected

Enumerator
Vertical
Horizontal
NOrientations

Definition at line 116 of file qquicklayout_p.h.

◆ SizeHint

enum QQuickLayout::SizeHint

Enumerator
MinimumSize
PreferredSize
MaximumSize
NSizes

Definition at line 45 of file qquicklayout_p.h.

◆ SizePolicy

enum QQuickLayout::SizePolicy

Enumerator
SizePolicyImplicit
SizePolicyExplicit

Definition at line 57 of file qquicklayout_p.h.

Constructor & Destructor Documentation

◆ QQuickLayout()

QQuickLayout::QQuickLayout	(	QQuickLayoutPrivate &	dd,
		QQuickItem *	parent = nullptr )

explicit

Definition at line 792 of file qquicklayout.cpp.

◆ ~QQuickLayout()

QQuickLayout::~QQuickLayout ( )

Definition at line 806 of file qquicklayout.cpp.

Member Function Documentation

◆ _q_dumpLayoutTree()

void QQuickLayout::_q_dumpLayoutTree ( ) const

Definition at line 1335 of file qquicklayout.cpp.

◆ checkAnchors()

void QQuickLayout::checkAnchors ( QQuickItem * item ) const

Definition at line 892 of file qquicklayout.cpp.

◆ componentComplete()

void QQuickLayout::componentComplete ( )

overridevirtual

\reimp Derived classes should call the base class method before adding their own actions to perform at componentComplete.

Reimplemented from QQuickItem.

Reimplemented in QQuickStackLayout.

Definition at line 837 of file qquicklayout.cpp.

◆ deactivateRecur()

void QQuickLayout::deactivateRecur ( )

QQuickLayout::deactivateRecur.

Call this from the dtor of the top-level layout. Otherwise, it will trigger lots of unneeded item change listeners (itemVisibleChanged()) for all its descendants that will have its impact thrown away.

Definition at line 1005 of file qquicklayout.cpp.

◆ dumpLayoutTreeRecursive()

void QQuickLayout::dumpLayoutTreeRecursive	(	int	level,
		QString &	buf ) const

Definition at line 1342 of file qquicklayout.cpp.

◆ effectiveSizeHints_helper()

void QQuickLayout::effectiveSizeHints_helper	(	QQuickItem *	item,
		QSizeF *	cachedSizeHints,
		QQuickLayoutAttached **	attachedInfo,
		bool	useFallbackToWidthOrHeight )

static

\internal
Note: Can potentially return the attached QQuickLayoutAttached object through \a attachedInfo.

It is like this is because it enables it to be reused.

The goal of this function is to return the effective minimum, preferred and maximum size hints
that the layout will use for this item.
This function takes care of gathering all explicitly set size hints, normalizes them so
that min < pref < max.
Further, the hints _not_explicitly_ set will then be initialized with the implicit size hints,
which is usually derived from the content of the layouts (or items).

The following table illustrates the preference of the properties used for measuring layout
items. If present, the USER properties will be preferred. If USER properties are not present,
the HINT properties will be preferred. Finally, the FALLBACK properties will be used as an
ultimate fallback.

Note that one can query if the value of Layout.minimumWidth or Layout.maximumWidth has been
explicitly or implicitly set with QQuickLayoutAttached::isExtentExplicitlySet(). This
determines if it should be used as a USER or as a HINT value.

Fractional size hints will be ceiled to the closest integer. This is in order to give some
slack when the items are snapped to the pixel grid.

             | *Minimum*            | *Preferred*           | *Maximum*                |

Definition at line 1182 of file qquicklayout.cpp.

◆ effectiveSizePolicy_helper()

QLayoutPolicy::Policy QQuickLayout::effectiveSizePolicy_helper	(	QQuickItem *	item,
		Qt::Orientation	orientation,
		QQuickLayoutAttached *	info )

static

Assumes info is set (if the object has an attached property)

Definition at line 1304 of file qquicklayout.cpp.

◆ ensureLayoutItemsUpdated()

void QQuickLayout::ensureLayoutItemsUpdated ( EnsureLayoutItemsUpdatedOptions options = {} ) const

Definition at line 899 of file qquicklayout.cpp.

◆ geometryChange()

void QQuickLayout::geometryChange	(	const QRectF &	newGeometry,
		const QRectF &	oldGeometry )

overridevirtual

Since: 6.0

This function is called to handle this item's changes in geometry from oldGeometry to newGeometry. If the two geometries are the same, it doesn't do anything.

Derived classes must call the base class method within their implementation.

Reimplemented from QQuickItem.

Definition at line 953 of file qquicklayout.cpp.

◆ invalidate()

void QQuickLayout::invalidate ( QQuickItem * childItem = nullptr )

virtual

Reimplemented in QQuickFlexboxLayout, QQuickGridLayoutBase, and QQuickStackLayout.

Definition at line 858 of file qquicklayout.cpp.

◆ invalidated()

bool QQuickLayout::invalidated ( ) const

Definition at line 1022 of file qquicklayout.cpp.

◆ invalidatedArrangement()

bool QQuickLayout::invalidatedArrangement ( ) const

Definition at line 1027 of file qquicklayout.cpp.

◆ invalidateSenderItem

void QQuickLayout::invalidateSenderItem ( )

protectedslot

Definition at line 983 of file qquicklayout.cpp.

◆ isMirrored()

bool QQuickLayout::isMirrored ( ) const

Definition at line 1032 of file qquicklayout.cpp.

◆ isReady()

bool QQuickLayout::isReady ( ) const

Definition at line 992 of file qquicklayout.cpp.

◆ itemAt()

virtual QQuickItem * QQuickLayout::itemAt ( int index ) const

pure virtual

Implemented in QQuickFlexboxLayout, QQuickGridLayoutBase, and QQuickStackLayout.

◆ itemChange()

void QQuickLayout::itemChange	(	ItemChange	change,
		const ItemChangeData &	value )

overridevirtual

Called when change occurs for this item.

value contains extra information relating to the change, when applicable.

If you re-implement this method in a subclass, be sure to call

QQuickItem::itemChange(change, value);

QQuickItem::itemChange

virtual void itemChange(ItemChange, const ItemChangeData &)

Called when change occurs for this item.

Definition qquickitem.cpp:5867

value

EGLOutputLayerEXT EGLint EGLAttrib value

[3]

Definition qeglstreamconvenience_p.h:46

typically at the end of your implementation, to ensure the \l windowChanged() signal will be emitted.

Reimplemented from QQuickItem.

Reimplemented in QQuickStackLayout.

Definition at line 931 of file qquicklayout.cpp.

◆ itemCount()

virtual int QQuickLayout::itemCount ( ) const

pure virtual

Implemented in QQuickFlexboxLayout, QQuickGridLayoutBase, and QQuickStackLayout.

◆ itemDestroyed()

void QQuickLayout::itemDestroyed ( QQuickItem * item )

overridevirtual

Reimplemented from QQuickItemChangeListener.

Definition at line 1057 of file qquicklayout.cpp.

◆ itemImplicitHeightChanged()

void QQuickLayout::itemImplicitHeightChanged ( QQuickItem * item )

overridevirtual

Reimplemented from QQuickItemChangeListener.

Definition at line 1050 of file qquicklayout.cpp.

◆ itemImplicitWidthChanged()

void QQuickLayout::itemImplicitWidthChanged ( QQuickItem * item )

overridevirtual

Reimplemented from QQuickItemChangeListener.

Definition at line 1043 of file qquicklayout.cpp.

◆ itemSiblingOrderChanged()

void QQuickLayout::itemSiblingOrderChanged ( QQuickItem * item )

overridevirtual

Reimplemented from QQuickItemChangeListener.

Reimplemented in QQuickStackLayout.

Definition at line 1037 of file qquicklayout.cpp.

◆ itemVisibilityChanged()

void QQuickLayout::itemVisibilityChanged ( QQuickItem * item )

overridevirtual

Reimplemented from QQuickItemChangeListener.

Definition at line 1062 of file qquicklayout.cpp.

◆ maybeSubscribeToBaseLineOffsetChanges()

void QQuickLayout::maybeSubscribeToBaseLineOffsetChanges ( QQuickItem * item )

Definition at line 846 of file qquicklayout.cpp.

◆ qmlAttachedProperties()

QQuickLayoutAttached * QQuickLayout::qmlAttachedProperties ( QObject * object )

static

Definition at line 815 of file qquicklayout.cpp.

◆ rearrange()

void QQuickLayout::rearrange ( const QSizeF & )

virtual

Reimplemented in QQuickFlexboxLayout, QQuickGridLayoutBase, and QQuickStackLayout.

Definition at line 1067 of file qquicklayout.cpp.

◆ setAlignment()

virtual void QQuickLayout::setAlignment	(	QQuickItem *	item,
		Qt::Alignment	align )

pure virtual

Implemented in QQuickFlexboxLayout, QQuickGridLayoutBase, and QQuickStackLayout.

◆ setStretchFactor()

virtual void QQuickLayout::setStretchFactor	(	QQuickItem *	item,
		int	stretchFactor,
		Qt::Orientation	orient )

pure virtual

Implemented in QQuickFlexboxLayout, QQuickGridLayoutBase, and QQuickStackLayout.

◆ shouldIgnoreItem()

bool QQuickLayout::shouldIgnoreItem ( QQuickItem * child ) const

Definition at line 883 of file qquicklayout.cpp.

◆ sizeHint()

virtual QSizeF QQuickLayout::sizeHint ( Qt::SizeHint whichSizeHint ) const

pure virtual

Implemented in QQuickFlexboxLayout, QQuickGridLayoutBase, and QQuickStackLayout.

◆ updateLayoutItems()

virtual void QQuickLayout::updateLayoutItems ( )

pure virtual

Implemented in QQuickFlexboxLayout, QQuickGridLayoutBase, and QQuickStackLayout.

◆ updatePolish()

void QQuickLayout::updatePolish ( )

overrideprotectedvirtual

This function should perform any layout as required for this item.

When polish() is called, the scene graph schedules a polish event for this item. When the scene graph is ready to render this item, it calls updatePolish() to do any item layout as required before it renders the next frame.

See also: ensurePolished()

Reimplemented from QQuickItem.

Definition at line 820 of file qquicklayout.cpp.

◆ QQuickLayoutAttached

friend class QQuickLayoutAttached

friend

Definition at line 131 of file qquicklayout_p.h.

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

qtdeclarative/src/quicklayouts/qquicklayout_p.h (f41f0607b2df21f979b3a5e5fc866abf9bf488b7)
qtdeclarative/src/quicklayouts/qquicklayout.cpp (f41f0607b2df21f979b3a5e5fc866abf9bf488b7)

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Slots

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ EnsureLayoutItemsUpdatedOption

◆ Orientation

◆ SizeHint

◆ SizePolicy

Constructor & Destructor Documentation

◆ QQuickLayout()

◆ ~QQuickLayout()

Member Function Documentation

◆ _q_dumpLayoutTree()

◆ checkAnchors()

◆ componentComplete()

◆ deactivateRecur()

◆ dumpLayoutTreeRecursive()

◆ effectiveSizeHints_helper()

◆ effectiveSizePolicy_helper()

◆ ensureLayoutItemsUpdated()

◆ geometryChange()

◆ invalidate()

◆ invalidated()

◆ invalidatedArrangement()

◆ invalidateSenderItem

◆ isMirrored()

◆ isReady()

◆ itemAt()

◆ itemChange()

◆ itemCount()

◆ itemDestroyed()

◆ itemImplicitHeightChanged()

◆ itemImplicitWidthChanged()

◆ itemSiblingOrderChanged()

◆ itemVisibilityChanged()

◆ maybeSubscribeToBaseLineOffsetChanges()

◆ qmlAttachedProperties()

◆ rearrange()

◆ setAlignment()

◆ setStretchFactor()

◆ shouldIgnoreItem()

◆ sizeHint()

◆ updateLayoutItems()

◆ updatePolish()

Friends And Related Symbol Documentation

◆ QQuickLayoutAttached