Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QQuickFlexboxLayoutPrivate Class Reference

The FlexboxLayout QML construct provides a flex layout for the quick items. More...

Inheritance diagram for QQuickFlexboxLayoutPrivate:
Collaboration diagram for QQuickFlexboxLayoutPrivate:

Public Member Functions

 QQuickFlexboxLayoutPrivate ()
const QQuickFlexboxLayoutEngine & getFlexEngine () const
 QQuickFlexboxLayoutPrivate ()
const QQuickFlexboxLayoutEngine & getFlexEngine () const
Public Member Functions inherited from QQuickLayoutPrivate
 QQuickLayoutPrivate ()
void applySizeHints () const
Public Member Functions inherited from QQuickItemPrivate
 QQuickItemPrivate ()
 ~QQuickItemPrivate () override
void init (QQuickItem *parent)
QQmlListProperty< QObject > data ()
QQmlListProperty< QObject > resources ()
QQmlListProperty< QQuickItem > children ()
QQmlListProperty< QQuickItem > visibleChildren ()
QQmlListProperty< QQuickState > states ()
QQmlListProperty< QQuickTransition > transitions ()
QString state () const
void setState (const QString &)
QQuickAnchorLine left () const
QQuickAnchorLine right () const
QQuickAnchorLine horizontalCenter () const
QQuickAnchorLine top () const
QQuickAnchorLine bottom () const
QQuickAnchorLine verticalCenter () const
QQuickAnchorLine baseline () const
void localizedTouchEvent (const QTouchEvent *event, bool isFiltering, QMutableTouchEvent *localized)
bool hasPointerHandlers () const
bool hasEnabledHoverHandlers () const
virtual void addPointerHandler (QQuickPointerHandler *h)
virtual void removePointerHandler (QQuickPointerHandler *h)
QObject * setContextMenu (QObject *menu)
void _q_resourceObjectDeleted (QObject *)
quint64 _q_createJSWrapper (QQmlV4ExecutionEnginePtr engine)
template<typename Fn, typename ... Args>
void notifyChangeListeners (QQuickItemPrivate::ChangeTypes changeTypes, Fn &&function, Args &&...args)
virtual void registerAsContainmentMask (QQuickItem *, bool)
QQuickAnchors * anchors () const
 \qmlpropertygroup QtQuick::Item::anchors \qmlproperty AnchorLine QtQuick::Item::anchors.top \qmlproperty AnchorLine QtQuick::Item::anchors.bottom \qmlproperty AnchorLine QtQuick::Item::anchors.left \qmlproperty AnchorLine QtQuick::Item::anchors.right \qmlproperty AnchorLine QtQuick::Item::anchors.horizontalCenter \qmlproperty AnchorLine QtQuick::Item::anchors.verticalCenter \qmlproperty AnchorLine QtQuick::Item::anchors.baseline
Qt::MouseButtons acceptedMouseButtons () const
void addItemChangeListener (QQuickItemChangeListener *listener, ChangeTypes types)
void updateOrAddItemChangeListener (QQuickItemChangeListener *listener, ChangeTypes types)
void removeItemChangeListener (QQuickItemChangeListener *, ChangeTypes types)
void updateOrAddGeometryChangeListener (QQuickItemChangeListener *listener, QQuickGeometryChange types)
void updateOrRemoveGeometryChangeListener (QQuickItemChangeListener *listener, QQuickGeometryChange types)
QQuickStateGroup * _states ()
QQuickItem::TransformOrigin origin () const
QString dirtyToString () const
void dirty (DirtyType)
void addToDirtyList ()
void removeFromDirtyList ()
void setCulled (bool)
QSGContext * sceneGraphContext () const
QSGRenderContext * sceneGraphRenderContext () const
QList< QQuickItem * > paintOrderChildItems () const
void addChild (QQuickItem *)
void removeChild (QQuickItem *)
void siblingOrderChanged ()
void markSortedChildrenDirty (QQuickItem *child)
void refWindow (QQuickWindow *)
void derefWindow ()
qreal effectiveDevicePixelRatio () const
void updateSubFocusItem (QQuickItem *scope, bool focus)
 Clears all sub focus items from scope.
bool setFocusIfNeeded (QEvent::Type)
Qt::FocusReason lastFocusChangeReason () const
virtual bool setLastFocusChangeReason (Qt::FocusReason reason)
QTransform windowToItemTransform () const
 Returns a transform that maps points from window space into item space.
QTransform itemToWindowTransform () const
 Returns a transform that maps points from item space into window space.
void itemToParentTransform (QTransform *) const
 Modifies t with this item's local transform relative to its parent.
void setX (qreal x)
void xChanged ()
 Q_OBJECT_COMPAT_PROPERTY (QQuickItemPrivate, qreal, x, &QQuickItemPrivate::setX, &QQuickItemPrivate::xChanged)
void setY (qreal y)
void yChanged ()
 Q_OBJECT_COMPAT_PROPERTY (QQuickItemPrivate, qreal, y, &QQuickItemPrivate::setY, &QQuickItemPrivate::yChanged)
void setWidth (qreal width)
void widthChanged ()
 Q_OBJECT_COMPAT_PROPERTY (QQuickItemPrivate, qreal, width, &QQuickItemPrivate::setWidth, &QQuickItemPrivate::widthChanged)
void setHeight (qreal height)
void heightChanged ()
 Q_OBJECT_COMPAT_PROPERTY (QQuickItemPrivate, qreal, height, &QQuickItemPrivate::setHeight, &QQuickItemPrivate::heightChanged)
bool widthValid () const
bool heightValid () const
qreal z () const
qreal scale () const
qreal rotation () const
qreal opacity () const
void setAccessible ()
virtual qreal getImplicitWidth () const
virtual qreal getImplicitHeight () const
virtual void implicitWidthChanged ()
virtual void implicitHeightChanged ()
void setImplicitAntialiasing (bool antialiasing)
void resolveLayoutMirror ()
void setImplicitLayoutMirror (bool mirror, bool inherit)
void setLayoutMirror (bool mirror)
bool isMirrored () const
void emitChildrenRectChanged (const QRectF &rect)
QPointF computeTransformOrigin () const
virtual bool transformChanged (QQuickItem *transformedItem)
QPointF adjustedPosForTransform (const QPointF &centroid, const QPointF &startPos, const QVector2D &activeTranslatation, qreal startScale, qreal activeScale, qreal startRotation, qreal activeRotation)
QQuickDeliveryAgent * deliveryAgent ()
QQuickDeliveryAgentPrivate * deliveryAgentPrivate ()
QQuickDeliveryAgent * ensureSubsceneDeliveryAgent ()
void deliverKeyEvent (QKeyEvent *)
bool filterKeyEvent (QKeyEvent *, bool post)
void deliverShortcutOverrideEvent (QKeyEvent *)
void deliverPointerEvent (QEvent *)
bool anyPointerHandlerWants (const QPointerEvent *event, const QEventPoint &point) const
virtual bool handlePointerEvent (QPointerEvent *, bool avoidGrabbers=false)
virtual void setVisible (bool visible)
bool isTransparentForPositioner () const
void setTransparentForPositioner (bool trans)
bool calcEffectiveVisible () const
bool setEffectiveVisibleRecur (bool)
bool calcEffectiveEnable () const
void setEffectiveEnableRecur (QQuickItem *scope, bool)
QSGTransformNode * itemNode ()
QSGNode * childContainerNode ()
QSGOpacityNode * opacityNode () const
QQuickDefaultClipNode * clipNode () const
QSGRootNode * rootNode () const
virtual QSGTransformNode * createTransformNode ()
void refFromEffectItem (bool hide)
void recursiveRefFromEffectItem (int refs)
void derefFromEffectItem (bool unhide)
void itemChange (QQuickItem::ItemChange, const QQuickItem::ItemChangeData &)
void enableSubtreeChangeNotificationsForParentHierachy ()
virtual void mirrorChange ()
void setHasCursorInChild (bool hasCursor)
void setHasHoverInChild (bool hasHover)
virtual void updatePolish ()
virtual void dumpItemTree (int indent) const
QLayoutPolicy sizePolicy () const
void setSizePolicy (const QLayoutPolicy::Policy &horizontalPolicy, const QLayoutPolicy::Policy &verticalPolicy)
Public Member Functions inherited from QObjectPrivate
void ensureExtraData ()
void setObjectNameWithoutBindings (const QString &name)
 QObjectPrivate (decltype(QObjectPrivateVersion) version=QObjectPrivateVersion)
virtual ~QObjectPrivate ()
void deleteChildren ()
void clearBindingStorage ()
void setParent_helper (QObject *)
void moveToThread_helper ()
void setThreadData_helper (QThreadData *currentData, QThreadData *targetData, QBindingStatus *status)
QObjectList receiverList (const char *signal) const
void ensureConnectionData ()
void addConnection (int signal, Connection *c)
int signalIndex (const char *signalName, const QMetaObject **meta=nullptr) const
bool isSignalConnected (uint signalIdx, bool checkDeclarative=true) const
bool maybeSignalConnected (uint signalIndex) const
bool isDeclarativeSignalConnected (uint signalIdx) const
void connectNotify (const QMetaMethod &signal)
void disconnectNotify (const QMetaMethod &signal)
void reinitBindingStorageAfterThreadMove ()
virtual std::string flagsForDumping () const
virtual void writeToDebugStream (QDebug &) const
QtPrivate::QPropertyAdaptorSlotObject * getPropertyAdaptorSlotObject (const QMetaProperty &property)
Public Member Functions inherited from QObjectData
 QObjectData ()=default
virtual ~QObjectData ()=0
const QMetaObject * dynamicMetaObject () const
Public Member Functions inherited from QQuickPaletteProviderPrivateBase< QQuickItem, QQuickItemPrivate >
virtual ~QQuickPaletteProviderPrivateBase ()=default
virtual QQuickPalette * palette () const
virtual void setPalette (QQuickPalette *p)
virtual void resetPalette ()
virtual bool providesPalette () const
QPalette defaultPalette () const override
QPalette parentPalette (const QPalette &fallbackPalette) const override
void inheritPalette (const QPalette &parentPalette)
virtual void updateChildrenPalettes (const QPalette &parentPalette)
Public Member Functions inherited from QQuickAbstractPaletteProvider
virtual ~QQuickAbstractPaletteProvider ()=default

Additional Inherited Members

Public Types inherited from QQuickItemPrivate
enum  ChangeType {
  Geometry = 0x01 , SiblingOrder = 0x02 , Visibility = 0x04 , Opacity = 0x08 ,
  Destroyed = 0x10 , Parent = 0x20 , Children = 0x40 , Rotation = 0x80 ,
  ImplicitWidth = 0x100 , ImplicitHeight = 0x200 , Enabled = 0x400 , Focus = 0x800 ,
  Scale = 0x1000 , Matrix = 0x2000 , AllChanges = 0xFFFFFFFF
}
enum  ExtraDataTag { NoTag = 0x1 , LeftMouseButtonAccepted = 0x2 }
enum  DirtyType {
  TransformOrigin = 0x00000001 , Transform = 0x00000002 , BasicTransform = 0x00000004 , Position = 0x00000008 ,
  Size = 0x00000010 , ZValue = 0x00000020 , Content = 0x00000040 , Smooth = 0x00000080 ,
  OpacityValue = 0x00000100 , ChildrenChanged = 0x00000200 , ChildrenStackingChanged = 0x00000400 , ParentChanged = 0x00000800 ,
  Clip = 0x00001000 , Window = 0x00002000 , EffectReference = 0x00008000 , Visible = 0x00010000 ,
  HideReference = 0x00020000 , Antialiasing = 0x00040000 , TransformUpdateMask , ComplexTransformUpdateMask = Transform | Window ,
  ContentUpdateMask = Size | Content | Smooth | Window | Antialiasing , ChildrenUpdateMask = ChildrenChanged | ChildrenStackingChanged | EffectReference | Window
}
Public Types inherited from QObjectPrivate
typedef void(* StaticMetaCallFunction) (QObject *, QMetaObject::Call, int, void **)
using ConnectionDataPointer = QExplicitlySharedDataPointer<ConnectionData>
Static Public Member Functions inherited from QQuickItemPrivate
static QQuickItemPrivate * get (QQuickItem *item)
static const QQuickItemPrivate * get (const QQuickItem *item)
static void data_append (QQmlListProperty< QObject > *, QObject *)
static qsizetype data_count (QQmlListProperty< QObject > *)
 \qmlproperty list<QtObject> QtQuick::Item::data \qmldefault
static QObject * data_at (QQmlListProperty< QObject > *, qsizetype)
static void data_clear (QQmlListProperty< QObject > *)
static void data_removeLast (QQmlListProperty< QObject > *)
static QObject * resources_at (QQmlListProperty< QObject > *, qsizetype)
static void resources_append (QQmlListProperty< QObject > *, QObject *)
static qsizetype resources_count (QQmlListProperty< QObject > *)
static void resources_clear (QQmlListProperty< QObject > *)
static void resources_removeLast (QQmlListProperty< QObject > *)
static void children_append (QQmlListProperty< QQuickItem > *, QQuickItem *)
static qsizetype children_count (QQmlListProperty< QQuickItem > *)
static QQuickItem * children_at (QQmlListProperty< QQuickItem > *, qsizetype)
static void children_clear (QQmlListProperty< QQuickItem > *)
static void children_removeLast (QQmlListProperty< QQuickItem > *)
static qsizetype visibleChildren_count (QQmlListProperty< QQuickItem > *prop)
static QQuickItem * visibleChildren_at (QQmlListProperty< QQuickItem > *prop, qsizetype index)
static qsizetype transform_count (QQmlListProperty< QQuickTransform > *list)
static void transform_append (QQmlListProperty< QQuickTransform > *list, QQuickTransform *)
static QQuickTransform * transform_at (QQmlListProperty< QQuickTransform > *list, qsizetype)
static void transform_clear (QQmlListProperty< QQuickTransform > *list)
static bool focusNextPrev (QQuickItem *item, bool forward)
 QQuickItemPrivate::focusNextPrev focuses the next/prev item in the tab-focus-chain.
static QQuickItem * nextTabChildItem (const QQuickItem *item, int start)
static QQuickItem * prevTabChildItem (const QQuickItem *item, int start)
static QQuickItem * nextPrevItemInTabFocusChain (QQuickItem *item, bool forward, bool wrap=true)
static bool canAcceptTabFocus (QQuickItem *item)
Static Public Member Functions inherited from QObjectPrivate
static bool removeConnection (Connection *c)
static QObjectPrivate * get (QObject *o)
static const QObjectPrivate * get (const QObject *o)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiverPrivate, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiverPrivate, Func2 slot)
static QMetaObject::Connection connectImpl (const QObject *sender, int signal_index, const QObject *receiver, void **slot, QtPrivate::QSlotObjectBase *slotObj, int type, const int *types, const QMetaObject *senderMetaObject)
static QMetaObject::Connection connect (const QObject *sender, int signal_index, QtPrivate::QSlotObjectBase *slotObj, Qt::ConnectionType type)
static QMetaObject::Connection connect (const QObject *sender, int signal_index, const QObject *receiver, QtPrivate::QSlotObjectBase *slotObj, Qt::ConnectionType type)
static bool disconnect (const QObject *sender, int signal_index, void **slot)
static bool disconnect (const QObject *sender, int signal_index, const QObject *receiver, void **slot)
Public Attributes inherited from QQuickItemPrivate
QLazilyAllocated< ExtraData, ExtraDataTags > extra
QQuickAnchors * _anchors
QVector< QQuickItemPrivate::ChangeListener > changeListeners
QQuickStateGroup * _stateGroup
quint32 flags:7
quint32 widthValidFlag:1
quint32 heightValidFlag:1
quint32 componentComplete:1
quint32 keepMouse:1
quint32 keepTouch:1
quint32 hoverEnabled:1
quint32 smooth:1
quint32 antialiasing:1
quint32 focus:1
quint32 activeFocus:1
quint32 notifiedFocus:1
quint32 notifiedActiveFocus:1
quint32 filtersChildMouseEvents:1
quint32 explicitVisible:1
quint32 effectiveVisible:1
quint32 explicitEnable:1
quint32 effectiveEnable:1
quint32 polishScheduled:1
quint32 inheritedLayoutMirror:1
quint32 effectiveLayoutMirror:1
quint32 isMirrorImplicit:1
quint32 inheritMirrorFromParent:1
quint32 inheritMirrorFromItem:1
quint32 isAccessible:1
quint32 culled:1
quint32 hasCursor:1
quint32 subtreeCursorEnabled:1
quint32 subtreeHoverEnabled:1
quint32 activeFocusOnTab:1
quint32 implicitAntialiasing:1
quint32 antialiasingValid:1
quint32 isTabFence:1
quint32 replayingPressEvent:1
quint32 touchEnabled:1
quint32 hasCursorHandler:1
quint32 maybeHasSubsceneDeliveryAgent:1
quint32 subtreeTransformChangedEnabled:1
quint32 inDestructor:1
quint32 focusReason:4
quint32 focusPolicy:4
quint32 dirtyAttributes
QQuickItem * nextDirtyItem
QQuickItem ** prevDirtyItem
QQuickWindow * window
int windowRefCount
QQuickItem * parentItem
QList< QQuickItem * > childItems
QList< QQuickItem * > * sortedChildItems
QPointer< QQuickItem > subFocusItem
qreal implicitWidth
qreal implicitHeight
qreal baselineOffset
QList< QQuickTransform * > transforms
QSGTransformNode * itemNodeInstance
QSGNode * paintNode
QLayoutPolicy szPolicy
Public Attributes inherited from QObjectPrivate
ExtraData * extraData
QAtomicPointer< QThreadData > threadData
QAtomicPointer< ConnectionData > connections
union { 
   QObject *   currentChildBeingDeleted 
   QAbstractDeclarativeData *   declarativeData 
}; 
QAtomicPointer< QtSharedPointer::ExternalRefCountData > sharedRefcount
Public Attributes inherited from QObjectData
QObject * q_ptr
QObject * parent
QObjectList children
uint isWidget: 1
uint blockSig: 1
uint wasDeleted: 1
uint isDeletingChildren: 1
uint sendChildEvents: 1
uint receiveChildEvents: 1
uint isWindow: 1
uint deleteLaterCalled: 1
uint isQuickItem: 1
uint willBeWidget: 1
uint wasWidget: 1
uint receiveParentEvents: 1
uint unused: 20
QAtomicInt postedEvents
QDynamicMetaObjectData * metaObject
QBindingStorage bindingStorage
Protected Member Functions inherited from QQuickPaletteProviderPrivateBase< QQuickItem, QQuickItemPrivate >
void setCurrentColorGroup ()
Protected Attributes inherited from QQuickLayoutPrivate
unsigned m_dirty: 1
unsigned m_dirtyArrangement: 1
unsigned m_isReady: 1
unsigned m_disableRearrange: 1
unsigned m_hasItemChangeListeners: 1

Detailed Description

The FlexboxLayout QML construct provides a flex layout for the quick items. 

\qmltype FlexboxLayout

! \nativetype QQuickFlexboxLayout \inherits Item \inqmlmodule QtQuick.Layouts

Since
6.10 \preliminary

The FlexboxLayout enables to layout the quick items in a flexible way as similar to that of \l {https://www.w3.org/TR/css-flexbox-1/}{CSS Flexible Box Layout}. Internally Qt FlexboxLayout uses the \l{qtquick-attribution-yoga.html}{yoga engine} to derive the geometry of the flex items. The \l {https://www.yogalayout.dev/}{yoga library} is a subset of the \l {https://www.w3.org/TR/css-flexbox-1/}{CSS Flexible Box Layout}. Thus FlexboxLayout can be limited to the feature as supported in the \l {https://www.yogalayout.dev/}{yoga library}.

Note
The FlexboxLayout adheres to yoga library version 2.0 for its features.

The items within the FlexboxLayout can be configured with preferred, minimum and maximum sizes through the existing layout attached properties. For instance, if the item within the FlexboxLayout need to be stretched, the layout attached property \l{Layout::fillWidth}{Layout.fillWidth} or \l{Layout::fillHeight}{Layout.fillHeight} can be set.

Items in a FlexboxLayout support these attached properties: \list

  • \l{FlexboxLayout::alignSelf}{FlexboxLayout.alignSelf}
  • \l{Layout::minimumWidth}{Layout.minimumWidth}
  • \l{Layout::minimumHeight}{Layout.minimumHeight}
  • \l{Layout::preferredWidth}{Layout.preferredWidth}
  • \l{Layout::preferredHeight}{Layout.preferredHeight}
  • \l{Layout::maximumWidth}{Layout.maximumWidth}
  • \l{Layout::maximumHeight}{Layout.maximumHeight}
  • \l{Layout::fillWidth}{Layout.fillWidth}
  • \l{Layout::fillHeight}{Layout.fillHeight}
  • \l{Layout::margins}{Layout.margins}
  • \l{Layout::leftMargin}{Layout.leftMargin}
  • \l{Layout::rightMargin}{Layout.rightMargin}
  • \l{Layout::topMargin}{Layout.topMargin}
  • \l{Layout::bottomMargin}{Layout.bottomMargin} \endlist

Read more about attached properties \l{QML Object Attributes}{here}.

See also
ColumnLayout
GridLayout
RowLayout
{QtQuick.Controls::StackView}{StackView}
{Qt Quick Layouts Overview}

To be able to use this type more efficiently, it is recommended that you understand the general mechanism of the Qt Quick Layouts module. Refer to \l{Qt Quick Layouts Overview} for more information.

Definition at line 82 of file qquickflexboxlayout.cpp.

Constructor & Destructor Documentation

◆ QQuickFlexboxLayoutPrivate() [1/2]

QQuickFlexboxLayoutPrivate::QQuickFlexboxLayoutPrivate ( )
inline

Definition at line 87 of file qquickflexboxlayout.cpp.

◆ QQuickFlexboxLayoutPrivate() [2/2]

QQuickFlexboxLayoutPrivate::QQuickFlexboxLayoutPrivate ( )
inline

Definition at line 87 of file qquickflexboxlayout.cpp.

Member Function Documentation

◆ getFlexEngine() [1/2]

const QQuickFlexboxLayoutEngine & QQuickFlexboxLayoutPrivate::getFlexEngine ( ) const
inline

Definition at line 88 of file qquickflexboxlayout.cpp.

◆ getFlexEngine() [2/2]

const QQuickFlexboxLayoutEngine & QQuickFlexboxLayoutPrivate::getFlexEngine ( ) const
inline

Definition at line 88 of file qquickflexboxlayout.cpp.

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