Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QQuickLayout Class Referenceabstract

#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 }
 
- Public Types inherited from QQuickItem
enum  Flag {
  ItemClipsChildrenToShape = 0x01 , ItemIsFocusScope = 0x04 , ItemHasContents = 0x08 , ItemAcceptsDrops = 0x10 ,
  ItemIsViewport = 0x20 , ItemObservesViewport = 0x40
}
 \qmltype Item \instantiates QQuickItem \inherits QtObject \inqmlmodule QtQuick More...
 
enum  ItemChange {
  ItemChildAddedChange , ItemChildRemovedChange , ItemSceneChange , ItemVisibleHasChanged ,
  ItemParentHasChanged , ItemOpacityHasChanged , ItemActiveFocusHasChanged , ItemRotationHasChanged ,
  ItemAntialiasingHasChanged , ItemDevicePixelRatioHasChanged , ItemEnabledHasChanged
}
 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 {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 QQuickItemitemAt (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.
 
QQuickWindowwindow () const
 Returns the window in which this item is rendered.
 
QQuickItemparentItem () const
 
void setParentItem (QQuickItem *parent)
 
void stackBefore (const QQuickItem *)
 Moves the specified sibling item to the index before this item within the list of children.
 
void stackAfter (const QQuickItem *)
 Moves the specified sibling item to the index after this 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< QQuickTransformtransform ()
 
qreal x () const
 
qreal y () const
 
QPointF position () const
 
void setX (qreal)
 
void setY (qreal)
 
void setPosition (const QPointF &)
 
QBindable< qrealbindableX ()
 
QBindable< qrealbindableY ()
 
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< qrealbindableWidth ()
 
qreal height () const
 
void setHeight (qreal)
 
void resetHeight ()
 
void setImplicitHeight (qreal)
 
qreal implicitHeight () const
 
QBindable< qrealbindableHeight ()
 
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().
 
QQuickItemviewportItem () 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.
 
QQuickItemscopedFocusItem () 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< QQuickItemGrabResultgrabToImage (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)
 
QObjectcontainmentMask () 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 QQuickItemchildAt (qreal x, qreal y) const
 \qmlmethod 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 QSGTextureProvidertextureProvider () 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< QStringbindableObjectName ()
 
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 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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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 QQuickAnchorsPrivateanchorPrivate ()
 

Static Public Member Functions

static QQuickLayoutAttachedqmlAttachedProperties (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 QSGNodeupdatePaintNode (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
QObjectsender () 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 QSizetargetSize = QSize())
 
qreal y const
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QQuickItem
QQuickItemparent
 \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< QQuickTransformtransform
 \qmlproperty list<Transform> QtQuick::Item::transform This property holds the list of transformations to apply.
 
bool smooth
 \qmlproperty bool QtQuick::Item::smooth
 
bool antialiasing
 \qmlproperty bool QtQuick::Item::antialiasing
 
qreal implicitWidth
 
qreal implicitHeight
 
QObjectcontainmentMask
 \qmlproperty QObject* QtQuick::Item::containmentMask
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 34 of file qquicklayout_p.h.

Member Enumeration Documentation

◆ EnsureLayoutItemsUpdatedOption

Enumerator
Recursive 
ApplySizeHints 

Definition at line 51 of file qquicklayout_p.h.

◆ Orientation

enum QQuickLayout::Orientation
protected
Enumerator
Vertical 
Horizontal 
NOrientations 

Definition at line 109 of file qquicklayout_p.h.

◆ SizeHint

Enumerator
MinimumSize 
PreferredSize 
MaximumSize 
NSizes 

Definition at line 44 of file qquicklayout_p.h.

Constructor & Destructor Documentation

◆ QQuickLayout()

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

Definition at line 761 of file qquicklayout.cpp.

◆ ~QQuickLayout()

QQuickLayout::~QQuickLayout ( )

Definition at line 775 of file qquicklayout.cpp.

References changeTypes, child, QQuickItem::childItems(), and QQuickItemPrivate::get().

+ Here is the call graph for this function:

Member Function Documentation

◆ _q_dumpLayoutTree()

void QQuickLayout::_q_dumpLayoutTree ( ) const

Definition at line 1281 of file qquicklayout.cpp.

References dumpLayoutTreeRecursive(), qDebug, and qPrintable.

+ Here is the call graph for this function:

◆ checkAnchors()

void QQuickLayout::checkAnchors ( QQuickItem * item) const

Definition at line 861 of file qquicklayout.cpp.

References QQuickAnchors::activeDirections(), anchors(), QQuickItemPrivate::get(), item, and qmlWarning().

Referenced by QQuickGridLayout::insertLayoutItems(), and QQuickLinearLayout::insertLayoutItems().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ 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 806 of file qquicklayout.cpp.

References QQuickItem::componentComplete(), and d.

Referenced by QQuickGridLayoutBase::componentComplete(), and QQuickStackLayout::componentComplete().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ 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 955 of file qquicklayout.cpp.

References changeTypes, ensureLayoutItemsUpdated(), QQuickItemPrivate::get(), i, item, itemAt(), itemCount(), and layout.

Referenced by QQuickGridLayoutBase::~QQuickGridLayoutBase().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ dumpLayoutTreeRecursive()

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

Definition at line 1288 of file qquicklayout.cpp.

References attachedLayoutObject(), QQuickItem::childItems(), fmt, QSizeF::height(), Qt::Horizontal, info, invalidated(), item, Qt::MaximumSize, Qt::MinimumSize, QString::number(), Qt::PreferredSize, QQmlMetaType::prettyTypeName(), sizeHint(), Qt::Vertical, and QSizeF::width().

Referenced by _q_dumpLayoutTree().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

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

+-------------—+-------------------—+--------------------—+-----------------------—+ |USER (explicit) | Layout.minimumWidth | Layout.preferredWidth | Layout.maximumWidth | |HINT (implicit) | Layout.minimumWidth | implicitWidth | Layout.maximumWidth | |FALLBACK | 0 | width | Number.POSITIVE_INFINITY | +-------------—+-------------------—+--------------------—+-----------------------—+

Definition at line 1132 of file qquicklayout.cpp.

References attachedLayoutObject(), QMarginsF::bottom(), boundSize(), combineImplicitHints(), combineSize(), expandSize(), QSizeF::height(), Qt::Horizontal, i, QQuickItem::implicitHeight, QQuickItem::implicitWidth, info, item, QMarginsF::left(), QQuickLayoutAttached::maximumHeight, Qt::MaximumSize, QQuickLayoutAttached::maximumWidth, Qt::MinimumDescent, QQuickLayoutAttached::minimumHeight, Qt::MinimumSize, QQuickLayoutAttached::minimumWidth, normalizeHints(), Qt::NSizeHints, NSizes, NSizes, QQuickLayoutAttached::preferredHeight, Qt::PreferredSize, QQuickLayoutAttached::preferredWidth, Q_ASSERT, qCeil(), QSizeF::rheight(), QMarginsF::right(), QSizeF::rwidth(), QSizeF::setHeight(), QSizeF::setWidth(), QQuickItem::size(), QMarginsF::top(), and Qt::Vertical.

Referenced by QQuickGridLayoutItem::effectiveSizeHints().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ 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 1254 of file qquicklayout.cpp.

References Qt::AA_QtQuickUseDefaultSizePolicy, QLayoutPolicy::Fixed, QQuickItemPrivate::get(), Qt::Horizontal, info, item, policy, QLayoutPolicy::Preferred, and QCoreApplication::testAttribute().

Referenced by QQuickGridLayoutItem::sizePolicy().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ensureLayoutItemsUpdated()

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

Definition at line 868 of file qquicklayout.cpp.

References ApplySizeHints, d, i, invalidated(), itemAt(), itemCount(), priv(), qCDebug, Recursive, and updateLayoutItems().

Referenced by QQuickGridLayoutBase::componentComplete(), QQuickStackLayout::componentComplete(), deactivateRecur(), QQuickGridLayoutBase::rearrange(), and updatePolish().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ 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 922 of file qquicklayout.cpp.

References d, QQuickItem::geometryChange(), invalidated(), isReady(), qCDebug, rearrange(), and QRectF::size().

+ Here is the call graph for this function:

◆ invalidate()

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

Reimplemented in QQuickGridLayoutBase, and QQuickStackLayout.

Definition at line 827 of file qquicklayout.cpp.

References d, invalidated(), QQuickItem::parentItem(), QQuickItem::polish(), and qCDebug.

Referenced by QQuickGridLayoutBase::invalidate(), QQuickStackLayout::invalidate(), invalidateSenderItem(), itemChange(), itemImplicitHeightChanged(), itemImplicitWidthChanged(), and itemSiblingOrderChanged().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ invalidated()

bool QQuickLayout::invalidated ( ) const

Definition at line 972 of file qquicklayout.cpp.

Referenced by dumpLayoutTreeRecursive(), ensureLayoutItemsUpdated(), geometryChange(), invalidate(), and QQuickGridLayoutBase::invalidate().

+ Here is the caller graph for this function:

◆ invalidatedArrangement()

bool QQuickLayout::invalidatedArrangement ( ) const

Definition at line 977 of file qquicklayout.cpp.

◆ invalidateSenderItem

void QQuickLayout::invalidateSenderItem ( )
protectedslot

Definition at line 933 of file qquicklayout.cpp.

References invalidate(), isReady(), item, Q_ASSERT, and QObject::sender().

Referenced by maybeSubscribeToBaseLineOffsetChanges().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isMirrored()

bool QQuickLayout::isMirrored ( ) const

Definition at line 982 of file qquicklayout.cpp.

◆ isReady()

◆ itemAt()

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

Implemented in QQuickGridLayoutBase, and QQuickStackLayout.

Referenced by deactivateRecur(), and ensureLayoutItemsUpdated().

+ Here is the caller graph for this function:

◆ 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

virtual void itemChange(ItemChange, const ItemChangeData &)
Called when change occurs for this item.
EGLOutputLayerEXT EGLint EGLAttrib value
[5]

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 900 of file qquicklayout.cpp.

References changeTypes, d, QQuickItemPrivate::get(), invalidate(), isReady(), item, QQuickItem::itemChange(), QQuickItem::ItemChildAddedChange, QQuickItem::ItemChildRemovedChange, maybeSubscribeToBaseLineOffsetChanges(), and qCDebug.

Referenced by QQuickStackLayout::itemChange().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ itemCount()

virtual int QQuickLayout::itemCount ( ) const
pure virtual

Implemented in QQuickGridLayoutBase, and QQuickStackLayout.

Referenced by deactivateRecur(), and ensureLayoutItemsUpdated().

+ Here is the caller graph for this function:

◆ itemDestroyed()

void QQuickLayout::itemDestroyed ( QQuickItem * item)
overridevirtual

Reimplemented from QQuickItemChangeListener.

Definition at line 1007 of file qquicklayout.cpp.

References item, and Q_UNUSED.

◆ itemImplicitHeightChanged()

void QQuickLayout::itemImplicitHeightChanged ( QQuickItem * item)
overridevirtual

Reimplemented from QQuickItemChangeListener.

Definition at line 1000 of file qquicklayout.cpp.

References invalidate(), isReady(), and item.

+ Here is the call graph for this function:

◆ itemImplicitWidthChanged()

void QQuickLayout::itemImplicitWidthChanged ( QQuickItem * item)
overridevirtual

Reimplemented from QQuickItemChangeListener.

Definition at line 993 of file qquicklayout.cpp.

References invalidate(), isReady(), and item.

+ Here is the call graph for this function:

◆ itemSiblingOrderChanged()

void QQuickLayout::itemSiblingOrderChanged ( QQuickItem * item)
overridevirtual

Reimplemented from QQuickItemChangeListener.

Reimplemented in QQuickStackLayout.

Definition at line 987 of file qquicklayout.cpp.

References invalidate(), item, and Q_UNUSED.

+ Here is the call graph for this function:

◆ itemVisibilityChanged()

void QQuickLayout::itemVisibilityChanged ( QQuickItem * item)
overridevirtual

Reimplemented from QQuickItemChangeListener.

Definition at line 1012 of file qquicklayout.cpp.

References item, and Q_UNUSED.

◆ maybeSubscribeToBaseLineOffsetChanges()

void QQuickLayout::maybeSubscribeToBaseLineOffsetChanges ( QQuickItem * item)

Definition at line 815 of file qquicklayout.cpp.

References Qt::AlignBaseline, attachedLayoutObject(), QQuickItem::baselineOffsetChanged(), info, invalidateSenderItem(), item, QGraphicsItem::parentItem(), qmlobject_connect, qmlobject_disconnect, SIGNAL, and SLOT.

Referenced by itemChange(), and QQuickGridLayoutBase::setAlignment().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ qmlAttachedProperties()

QQuickLayoutAttached * QQuickLayout::qmlAttachedProperties ( QObject * object)
static

Definition at line 784 of file qquicklayout.cpp.

References QQuickLayoutAttached.

◆ rearrange()

void QQuickLayout::rearrange ( const QSizeF & )
virtual

Reimplemented in QQuickStackLayout, and QQuickGridLayoutBase.

Definition at line 1017 of file qquicklayout.cpp.

Referenced by geometryChange(), QQuickStackLayout::rearrange(), QQuickGridLayoutBase::rearrange(), and updatePolish().

+ Here is the caller graph for this function:

◆ setAlignment()

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

◆ setStretchFactor()

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

◆ shouldIgnoreItem()

bool QQuickLayout::shouldIgnoreItem ( QQuickItem * child) const

Definition at line 852 of file qquicklayout.cpp.

References child, and QQuickItemPrivate::get().

Referenced by QQuickGridLayout::insertLayoutItems(), and QQuickLinearLayout::insertLayoutItems().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ sizeHint()

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

Implemented in QQuickGridLayoutBase, and QQuickStackLayout.

Referenced by dumpLayoutTreeRecursive().

+ Here is the caller graph for this function:

◆ updateLayoutItems()

virtual void QQuickLayout::updateLayoutItems ( )
pure virtual

Implemented in QQuickGridLayoutBase, and QQuickStackLayout.

Referenced by ensureLayoutItemsUpdated().

+ Here is the caller graph for this function:

◆ 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 789 of file qquicklayout.cpp.

References ApplySizeHints, ensureLayoutItemsUpdated(), QQuickItem::height, qCDebug, rearrange(), Recursive, and QQuickItem::width.

+ Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ QQuickLayoutAttached

friend class QQuickLayoutAttached
friend

Definition at line 124 of file qquicklayout_p.h.

Referenced by qmlAttachedProperties().


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