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
QQuickControl Class Reference

#include <qquickcontrol_p.h>

+ Inheritance diagram for QQuickControl:
+ Collaboration diagram for QQuickControl:

Signals

void fontChanged ()
 
void availableWidthChanged ()
 
void availableHeightChanged ()
 
void paddingChanged ()
 
void topPaddingChanged ()
 
void leftPaddingChanged ()
 
void rightPaddingChanged ()
 
void bottomPaddingChanged ()
 
void spacingChanged ()
 
void localeChanged ()
 
void focusReasonChanged ()
 
void mirroredChanged ()
 
void visualFocusChanged ()
 
void hoveredChanged ()
 
void hoverEnabledChanged ()
 
void wheelEnabledChanged ()
 
void backgroundChanged ()
 
void contentItemChanged ()
 
void baselineOffsetChanged ()
 
 Q_REVISION (2, 5) void horizontalPaddingChanged()
 
 Q_REVISION (2, 5) void verticalPaddingChanged()
 
 Q_REVISION (2, 5) void implicitContentWidthChanged()
 
 Q_REVISION (2, 5) void implicitContentHeightChanged()
 
 Q_REVISION (2, 5) void implicitBackgroundWidthChanged()
 
 Q_REVISION (2, 5) void implicitBackgroundHeightChanged()
 
 Q_REVISION (2, 5) void topInsetChanged()
 
 Q_REVISION (2, 5) void leftInsetChanged()
 
 Q_REVISION (2, 5) void rightInsetChanged()
 
 Q_REVISION (2, 5) void bottomInsetChanged()
 
- 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 Member Functions

 QQuickControl (QQuickItem *parent=nullptr)
 
 ~QQuickControl ()
 
QFont font () const
 \qmlproperty font QtQuick.Controls::Control::font
 
void setFont (const QFont &font)
 
void resetFont ()
 
qreal availableWidth () const
 \qmlproperty real QtQuick.Controls::Control::availableWidth \readonly
 
qreal availableHeight () const
 \qmlproperty real QtQuick.Controls::Control::availableHeight \readonly
 
qreal padding () const
 \qmlproperty real QtQuick.Controls::Control::padding
 
void setPadding (qreal padding)
 
void resetPadding ()
 
qreal topPadding () const
 \qmlproperty real QtQuick.Controls::Control::topPadding
 
void setTopPadding (qreal padding)
 
void resetTopPadding ()
 
qreal leftPadding () const
 \qmlproperty real QtQuick.Controls::Control::leftPadding
 
void setLeftPadding (qreal padding)
 
void resetLeftPadding ()
 
qreal rightPadding () const
 \qmlproperty real QtQuick.Controls::Control::rightPadding
 
void setRightPadding (qreal padding)
 
void resetRightPadding ()
 
qreal bottomPadding () const
 \qmlproperty real QtQuick.Controls::Control::bottomPadding
 
void setBottomPadding (qreal padding)
 
void resetBottomPadding ()
 
qreal spacing () const
 \qmlproperty real QtQuick.Controls::Control::spacing
 
void setSpacing (qreal spacing)
 
void resetSpacing ()
 
QLocale locale () const
 \qmlproperty Locale QtQuick.Controls::Control::locale
 
void setLocale (const QLocale &locale)
 
void resetLocale ()
 
bool isMirrored () const
 \qmlproperty bool QtQuick.Controls::Control::mirrored \readonly
 
Qt::FocusReason focusReason () const
 \qmlproperty enumeration QtQuick.Controls::Control::focusReason
 
void setFocusReason (Qt::FocusReason reason)
 
bool hasVisualFocus () const
 \qmlproperty bool QtQuick.Controls::Control::visualFocus \readonly
 
bool isHovered () const
 \qmlproperty bool QtQuick.Controls::Control::hovered \readonly
 
void setHovered (bool hovered)
 
bool isHoverEnabled () const
 \qmlproperty bool QtQuick.Controls::Control::hoverEnabled
 
void setHoverEnabled (bool enabled)
 
void resetHoverEnabled ()
 
bool isWheelEnabled () const
 \qmlproperty bool QtQuick.Controls::Control::wheelEnabled
 
void setWheelEnabled (bool enabled)
 
QQuickItembackground () const
 \qmlproperty Item QtQuick.Controls::Control::background
 
void setBackground (QQuickItem *background)
 
QQuickItemcontentItem () const
 \qmlproperty Item QtQuick.Controls::Control::contentItem
 
void setContentItem (QQuickItem *item)
 
qreal baselineOffset () const
 
void setBaselineOffset (qreal offset)
 
void resetBaselineOffset ()
 
qreal horizontalPadding () const
 
void setHorizontalPadding (qreal padding)
 
void resetHorizontalPadding ()
 
qreal verticalPadding () const
 
void setVerticalPadding (qreal padding)
 
void resetVerticalPadding ()
 
qreal implicitContentWidth () const
 
qreal implicitContentHeight () const
 
qreal implicitBackgroundWidth () const
 
qreal implicitBackgroundHeight () const
 
qreal topInset () const
 
void setTopInset (qreal inset)
 
void resetTopInset ()
 
qreal leftInset () const
 
void setLeftInset (qreal inset)
 
void resetLeftInset ()
 
qreal rightInset () const
 
void setRightInset (qreal inset)
 
void resetRightInset ()
 
qreal bottomInset () const
 
void setBottomInset (qreal inset)
 
void resetBottomInset ()
 
- 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 ()
 

Protected Member Functions

virtual QFont defaultFont () const
 
 QQuickControl (QQuickControlPrivate &dd, QQuickItem *parent)
 
void classBegin () override
 Invoked after class creation, but before any properties have been set.
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
void itemChange (ItemChange change, const ItemChangeData &value) override
 Called when change occurs for this item.
 
void focusInEvent (QFocusEvent *event) override
 This event handler can be reimplemented in a subclass to receive focus-in events for an item.
 
void focusOutEvent (QFocusEvent *event) override
 This event handler can be reimplemented in a subclass to receive focus-out events for an item.
 
void mousePressEvent (QMouseEvent *event) override
 This event handler can be reimplemented in a subclass to receive mouse press events for an item.
 
void mouseMoveEvent (QMouseEvent *event) override
 This event handler can be reimplemented in a subclass to receive mouse move events for an item.
 
void mouseReleaseEvent (QMouseEvent *event) override
 This event handler can be reimplemented in a subclass to receive mouse release events for an item.
 
void mouseUngrabEvent () override
 This event handler can be reimplemented in a subclass to be notified when a mouse ungrab event has occurred on this item.
 
void geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) override
 
virtual void fontChange (const QFont &newFont, const QFont &oldFont)
 
virtual void mirrorChange ()
 
virtual void spacingChange (qreal newSpacing, qreal oldSpacing)
 
virtual void paddingChange (const QMarginsF &newPadding, const QMarginsF &oldPadding)
 
virtual void contentItemChange (QQuickItem *newItem, QQuickItem *oldItem)
 
virtual void localeChange (const QLocale &newLocale, const QLocale &oldLocale)
 
virtual void insetChange (const QMarginsF &newInset, const QMarginsF &oldInset)
 
virtual void enabledChange ()
 
QString accessibleName () const
 
void maybeSetAccessibleName (const QString &name)
 
QVariant accessibleProperty (const char *propertyName)
 
bool setAccessibleProperty (const char *propertyName, const QVariant &value)
 
- 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.
 
void componentComplete () override
 \reimp Derived classes should call the base class method before adding their own actions to perform at componentComplete.
 
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 mouseDoubleClickEvent (QMouseEvent *event)
 This event handler can be reimplemented in a subclass to receive mouse double-click events for an 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().
 
virtual void updatePolish ()
 This function should perform any layout as required for this item.
 
 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)
 

Properties

QFont font
 
qreal availableWidth
 
qreal availableHeight
 
qreal padding
 
qreal topPadding
 
qreal leftPadding
 
qreal rightPadding
 
qreal bottomPadding
 
qreal spacing
 
QLocale locale
 
bool mirrored
 
Qt::FocusReason focusReason
 
bool visualFocus
 
bool hovered
 
bool hoverEnabled
 
bool wheelEnabled
 
QQuickItembackground
 
QQuickItemcontentItem
 
qreal baselineOffset
 
qreal horizontalPadding
 
qreal verticalPadding
 
qreal implicitContentWidth
 
qreal implicitContentHeight
 
qreal implicitBackgroundWidth
 
qreal implicitBackgroundHeight
 
qreal topInset
 
qreal leftInset
 
qreal rightInset
 
qreal bottomInset
 
- 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
 

Additional Inherited Members

- 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 Slots inherited from QQuickItem
void update ()
 Schedules a call to updatePaintNode() for this item.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- 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)
 
- Public Attributes inherited from QQuickItem
const QSizetargetSize = QSize())
 
qreal y const
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 31 of file qquickcontrol_p.h.

Constructor & Destructor Documentation

◆ QQuickControl() [1/2]

QQuickControl::QQuickControl ( QQuickItem * parent = nullptr)
explicit

Definition at line 918 of file qquickcontrol.cpp.

◆ ~QQuickControl()

QQuickControl::~QQuickControl ( )

Definition at line 932 of file qquickcontrol.cpp.

◆ QQuickControl() [2/2]

QQuickControl::QQuickControl ( QQuickControlPrivate & dd,
QQuickItem * parent )
protected

Definition at line 925 of file qquickcontrol.cpp.

Member Function Documentation

◆ accessibleName()

QString QQuickControl::accessibleName ( ) const
protected

Definition at line 2168 of file qquickcontrol.cpp.

◆ accessibleProperty()

QVariant QQuickControl::accessibleProperty ( const char * propertyName)
protected

Definition at line 2189 of file qquickcontrol.cpp.

◆ availableHeight()

qreal QQuickControl::availableHeight ( ) const

\qmlproperty real QtQuick.Controls::Control::availableHeight \readonly

This property holds the height available to the \l contentItem after deducting vertical padding from the \l {Item::}{height} of the control.

See also
{Control Layout}, padding, topPadding, bottomPadding

Definition at line 1070 of file qquickcontrol.cpp.

◆ availableHeightChanged

void QQuickControl::availableHeightChanged ( )
signal

◆ availableWidth()

qreal QQuickControl::availableWidth ( ) const

\qmlproperty real QtQuick.Controls::Control::availableWidth \readonly

This property holds the width available to the \l contentItem after deducting horizontal padding from the \l {Item::}{width} of the control.

See also
{Control Layout}, padding, leftPadding, rightPadding

Definition at line 1056 of file qquickcontrol.cpp.

◆ availableWidthChanged

void QQuickControl::availableWidthChanged ( )
signal

◆ background()

QQuickItem * QQuickControl::background ( ) const

\qmlproperty Item QtQuick.Controls::Control::background

This property holds the background item.

id: control
text: qsTr("Button")
background: Rectangle {
opacity: enabled ? 1 : 0.3
color: control.down ? "#d0d0d0" : "#e0e0e0"
}
}
QQuickItem * background
qreal implicitWidth
Definition qquickitem.h:114
qreal opacity
\qmlproperty real QtQuick::Item::opacity
Definition qquickitem.h:78
qreal implicitHeight
Definition qquickitem.h:115
QString text
[12]
Button
GLenum GLenum GLsizei const GLuint GLboolean enabled
GLenum GLuint id
[7]
GLuint color
[2]

\input qquickcontrol-background.qdocinc notes

See also
{Control Layout}

Definition at line 1547 of file qquickcontrol.cpp.

◆ backgroundChanged

void QQuickControl::backgroundChanged ( )
signal

◆ baselineOffset()

qreal QQuickControl::baselineOffset ( ) const

Definition at line 1644 of file qquickcontrol.cpp.

◆ baselineOffsetChanged

void QQuickControl::baselineOffsetChanged ( )
signal

◆ bottomInset()

qreal QQuickControl::bottomInset ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::Control::bottomInset

This property holds the bottom inset for the background.

See also
{Control Layout}, topInset

Definition at line 1922 of file qquickcontrol.cpp.

◆ bottomPadding()

qreal QQuickControl::bottomPadding ( ) const

\qmlproperty real QtQuick.Controls::Control::bottomPadding

This property holds the bottom padding. Unless explicitly set, the value is equal to verticalPadding.

See also
{Control Layout}, padding, topPadding, verticalPadding, availableHeight

Definition at line 1248 of file qquickcontrol.cpp.

◆ bottomPaddingChanged

void QQuickControl::bottomPaddingChanged ( )
signal

◆ classBegin()

void QQuickControl::classBegin ( )
overrideprotectedvirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Reimplemented in QQuickRangeSlider, QQuickScrollBar, and QQuickSpinBox.

Definition at line 1940 of file qquickcontrol.cpp.

◆ componentComplete()

void QQuickControl::componentComplete ( )
overrideprotectedvirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Reimplemented in QQuickDayOfWeekRow, QQuickDial, QQuickDialogButtonBox, QQuickFolderBreadcrumbBar, QQuickGroupBox, QQuickMenuBar, QQuickMenuItem, QQuickMonthGrid, QQuickPage, QQuickPane, QQuickProgressBar, QQuickRangeSlider, QQuickScrollBar, QQuickScrollView, QQuickSlider, QQuickSpinBox, QQuickSplitView, QQuickStackView, QQuickSwipeDelegate, QQuickSwipeView, QQuickTabBar, QQuickTreeViewDelegate, QQuickTumbler, and QQuickWeekNumberColumn.

Definition at line 1947 of file qquickcontrol.cpp.

◆ contentItem()

QQuickItem * QQuickControl::contentItem ( ) const

\qmlproperty Item QtQuick.Controls::Control::contentItem

This property holds the visual content item.

id: control
text: qsTr("Button")
contentItem: Label {
text: control.text
verticalAlignment: Text.AlignVCenter
}
}
QQuickItem * contentItem
Definition text.h:12
Note
The content item is automatically positioned and resized to fit within the \l padding of the control. Bindings to the \l[QtQuick]{Item::}{x}, \l[QtQuick]{Item::}{y}, \l[QtQuick]{Item::}{width}, and \l[QtQuick]{Item::}{height} properties of the contentItem are not respected.
Most controls use the implicit size of the content item to calculate the implicit size of the control itself. If you replace the content item with a custom one, you should also consider providing a sensible implicit size for it (unless it is an item like \l Text which has its own implicit size).
See also
{Control Layout}, padding

Definition at line 1630 of file qquickcontrol.cpp.

◆ contentItemChange()

void QQuickControl::contentItemChange ( QQuickItem * newItem,
QQuickItem * oldItem )
protectedvirtual

◆ contentItemChanged

void QQuickControl::contentItemChanged ( )
signal

◆ defaultFont()

◆ enabledChange()

void QQuickControl::enabledChange ( )
protectedvirtual

Reimplemented in QQuickPopupItem.

Definition at line 2094 of file qquickcontrol.cpp.

◆ focusInEvent()

void QQuickControl::focusInEvent ( QFocusEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive focus-in events for an item.

The event information is provided by the event parameter.

\input item.qdocinc accepting-events

If you do reimplement this function, you should call the base class implementation.

Reimplemented from QQuickItem.

Reimplemented in QQuickPopupItem, QQuickRangeSlider, and QQuickSpinBox.

Definition at line 1973 of file qquickcontrol.cpp.

◆ focusOutEvent()

void QQuickControl::focusOutEvent ( QFocusEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive focus-out events for an item.

The event information is provided by the event parameter.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Reimplemented in QQuickPopupItem.

Definition at line 1978 of file qquickcontrol.cpp.

◆ focusReason()

Qt::FocusReason QQuickControl::focusReason ( ) const

\qmlproperty enumeration QtQuick.Controls::Control::focusReason

This property holds the reason of the last focus change.

The value of this property is modified by Qt whenever focus is transferred, and you should never have to set this property yourself.

Note
This property does not indicate whether the item has \l {Item::activeFocus} {active focus}, but the reason why the item either gained or lost focus.

\value Qt.MouseFocusReason A mouse action occurred. \value Qt.TabFocusReason The Tab key was pressed. \value Qt.BacktabFocusReason A Backtab occurred. The input for this may include the Shift or Control keys; e.g. Shift+Tab. \value Qt.ActiveWindowFocusReason The window system made this window either active or inactive. \value Qt.PopupFocusReason The application opened/closed a pop-up that grabbed/released the keyboard focus. \value Qt.ShortcutFocusReason The user typed a label's buddy shortcut \value Qt.MenuBarFocusReason The menu bar took focus. \value Qt.OtherFocusReason Another reason, usually application-specific.

See also
Item::activeFocus
visualFocus

Definition at line 1385 of file qquickcontrol.cpp.

◆ focusReasonChanged

void QQuickControl::focusReasonChanged ( )
signal

◆ font()

QFont QQuickControl::font ( ) const

\qmlproperty font QtQuick.Controls::Control::font

This property holds the font currently set for the control.

This property describes the control's requested font. The font is used by the control's style when rendering standard components, and is available as a means to ensure that custom controls can maintain consistency with the native platform's native look and feel. It's common that different platforms, or different styles, define different fonts for an application.

The default font depends on the system environment. ApplicationWindow maintains a system/theme font which serves as a default for all controls. There may also be special font defaults for certain types of controls. You can also set the default font for controls by either:

\list

  • passing a custom font to QGuiApplication::setFont(), before loading the QML; or
  • specifying the fonts in the \l {Qt Quick Controls 2 Configuration File}{qtquickcontrols2.conf file}. \endlist

Finally, the font is matched against Qt's font database to find the best match.

Control propagates explicit font properties from parent to children. If you change a specific property on a control's font, that property propagates to all of the control's children, overriding any system defaults for that property.

Page {
font.family: "Courier"
Column {
Label {
text: qsTr("This will use Courier...")
}
Switch {
text: qsTr("... and so will this")
}
}
}
QString family() const
Returns the requested font family name.
Definition qfont.cpp:815

For the full list of available font properties, see the \l [QtQuick]{font}{font QML Value Type} documentation.

Definition at line 1023 of file qquickcontrol.cpp.

◆ fontChange()

void QQuickControl::fontChange ( const QFont & newFont,
const QFont & oldFont )
protectedvirtual

Reimplemented in QQuickComboBox, and QQuickPopupItem.

Definition at line 2098 of file qquickcontrol.cpp.

◆ fontChanged

void QQuickControl::fontChanged ( )
signal

◆ geometryChange()

void QQuickControl::geometryChange ( const QRectF & newGeometry,
const QRectF & oldGeometry )
overrideprotectedvirtual
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.

Reimplemented in QQuickDayOfWeekRow, QQuickDialogButtonBox, QQuickMenuBarItem, QQuickMonthGrid, QQuickPopupItem, QQuickRoundButton, QQuickSplitView, QQuickStackView, QQuickSwipeDelegate, QQuickSwipeView, QQuickTabBar, QQuickTreeViewDelegate, QQuickTumbler, and QQuickWeekNumberColumn.

Definition at line 2082 of file qquickcontrol.cpp.

◆ hasVisualFocus()

bool QQuickControl::hasVisualFocus ( ) const

\qmlproperty bool QtQuick.Controls::Control::visualFocus \readonly

This property holds whether the control has visual focus. This property is true when the control has active focus and the focus reason is either Qt.TabFocusReason, Qt.BacktabFocusReason, or Qt.ShortcutFocusReason.

In general, for visualizing key focus, this property is preferred over \l Item::activeFocus. This ensures that key focus is only visualized when interacting with keys - not when interacting via touch or mouse.

See also
focusReason, Item::activeFocus

Definition at line 1411 of file qquickcontrol.cpp.

◆ horizontalPadding()

qreal QQuickControl::horizontalPadding ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::Control::horizontalPadding

This property holds the horizontal padding. Unless explicitly set, the value is equal to padding.

See also
{Control Layout}, padding, leftPadding, rightPadding, verticalPadding

Definition at line 1677 of file qquickcontrol.cpp.

◆ hoveredChanged

void QQuickControl::hoveredChanged ( )
signal

◆ hoverEnabledChanged

void QQuickControl::hoverEnabledChanged ( )
signal

◆ implicitBackgroundHeight()

qreal QQuickControl::implicitBackgroundHeight ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::Control::implicitBackgroundHeight \readonly

This property holds the implicit background height.

The value is equal to {background ? background.implicitHeight : 0}.

This is typically used, together with \l implicitContentHeight, to calculate the \l {Item::}{implicitHeight}:

See also
implicitBackgroundWidth, implicitContentHeight

Definition at line 1828 of file qquickcontrol.cpp.

◆ implicitBackgroundWidth()

qreal QQuickControl::implicitBackgroundWidth ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::Control::implicitBackgroundWidth \readonly

This property holds the implicit background width.

The value is equal to {background ? background.implicitWidth : 0}.

This is typically used, together with \l implicitContentWidth, to calculate the \l {Item::}{implicitWidth}:

See also
implicitBackgroundHeight, implicitContentWidth

Definition at line 1799 of file qquickcontrol.cpp.

◆ implicitContentHeight()

qreal QQuickControl::implicitContentHeight ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::Control::implicitContentHeight \readonly

This property holds the implicit content height.

For basic controls, the value is equal to {contentItem ? contentItem.implicitHeight : 0}. For types that inherit Container or Pane, the value is calculated based on the content children.

This is typically used, together with \l implicitBackgroundHeight, to calculate the \l {Item::}{implicitHeight}:

See also
implicitContentWidth, implicitBackgroundHeight

Definition at line 1772 of file qquickcontrol.cpp.

◆ implicitContentWidth()

qreal QQuickControl::implicitContentWidth ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::Control::implicitContentWidth \readonly

This property holds the implicit content width.

For basic controls, the value is equal to {contentItem ? contentItem.implicitWidth : 0}. For types that inherit Container or Pane, the value is calculated based on the content children.

This is typically used, together with \l implicitBackgroundWidth, to calculate the \l {Item::}{implicitWidth}:

See also
implicitContentHeight, implicitBackgroundWidth

Definition at line 1744 of file qquickcontrol.cpp.

◆ insetChange()

void QQuickControl::insetChange ( const QMarginsF & newInset,
const QMarginsF & oldInset )
protectedvirtual

Definition at line 2142 of file qquickcontrol.cpp.

◆ isHovered()

bool QQuickControl::isHovered ( ) const

\qmlproperty bool QtQuick.Controls::Control::hovered \readonly

This property holds whether the control is hovered.

See also
hoverEnabled

Definition at line 1425 of file qquickcontrol.cpp.

◆ isHoverEnabled()

bool QQuickControl::isHoverEnabled ( ) const

\qmlproperty bool QtQuick.Controls::Control::hoverEnabled

This property determines whether the control accepts hover events. The default value is Application.styleHints.useHoverEffects.

Setting this property propagates the value to all child controls that do not have hoverEnabled explicitly set.

You can also enable or disable hover effects for all Qt Quick Controls applications by setting the QT_QUICK_CONTROLS_HOVER_ENABLED \l {Supported Environment Variables in Qt Quick Controls}{environment variable}.

See also
hovered

Definition at line 1465 of file qquickcontrol.cpp.

◆ isMirrored()

bool QQuickControl::isMirrored ( ) const

\qmlproperty bool QtQuick.Controls::Control::mirrored \readonly

This property holds whether the control is mirrored.

This property is provided for convenience. A control is considered mirrored when its visual layout direction is right-to-left; that is, when \l {LayoutMirroring::enabled}{LayoutMirroring.enabled} is true.

As of Qt 6.2, the \l locale property no longer affects this property.

See also
{LayoutMirroring}{LayoutMirroring}, {Right-to-left User Interfaces}

Definition at line 1354 of file qquickcontrol.cpp.

◆ isWheelEnabled()

bool QQuickControl::isWheelEnabled ( ) const

\qmlproperty bool QtQuick.Controls::Control::wheelEnabled

This property determines whether the control handles wheel events. The default value is false.

Note
Care must be taken when enabling wheel events for controls within scrollable items such as \l Flickable, as the control will consume the events and hence interrupt scrolling of the Flickable.

Definition at line 1509 of file qquickcontrol.cpp.

◆ itemChange()

void QQuickControl::itemChange ( QQuickItem::ItemChange change,
const ItemChangeData & value )
overrideprotectedvirtual

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 QQuickFolderBreadcrumbBar, QQuickMenuBar, QQuickPopupItem, and QQuickSpinBox.

Definition at line 944 of file qquickcontrol.cpp.

◆ leftInset()

qreal QQuickControl::leftInset ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::Control::leftInset

This property holds the left inset for the background.

See also
{Control Layout}, rightInset

Definition at line 1870 of file qquickcontrol.cpp.

◆ leftPadding()

qreal QQuickControl::leftPadding ( ) const

\qmlproperty real QtQuick.Controls::Control::leftPadding

This property holds the left padding. Unless explicitly set, the value is equal to horizontalPadding.

See also
{Control Layout}, padding, rightPadding, horizontalPadding, availableWidth

Definition at line 1196 of file qquickcontrol.cpp.

◆ leftPaddingChanged

void QQuickControl::leftPaddingChanged ( )
signal

◆ locale()

QLocale QQuickControl::locale ( ) const

\qmlproperty Locale QtQuick.Controls::Control::locale

This property holds the locale of the control.

It contains locale specific properties for formatting data and numbers. Unless a special locale has been set, this is either the parent's locale or the default locale.

Control propagates the locale from parent to children. If you change the control's locale, that locale propagates to all of the control's children, overriding the system default locale.

See also
mirrored

Definition at line 1315 of file qquickcontrol.cpp.

◆ localeChange()

void QQuickControl::localeChange ( const QLocale & newLocale,
const QLocale & oldLocale )
protectedvirtual

◆ localeChanged

void QQuickControl::localeChanged ( )
signal

◆ maybeSetAccessibleName()

void QQuickControl::maybeSetAccessibleName ( const QString & name)
protected

Definition at line 2177 of file qquickcontrol.cpp.

◆ mirrorChange()

void QQuickControl::mirrorChange ( )
protectedvirtual

◆ mirroredChanged

void QQuickControl::mirroredChanged ( )
signal

◆ mouseMoveEvent()

void QQuickControl::mouseMoveEvent ( QMouseEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive mouse move events for an item.

The event information is provided by the event parameter.

In order to receive mouse movement events, the preceding mouse press event must be accepted (by overriding \l mousePressEvent(), for example) and \l acceptedMouseButtons() must return the relevant mouse button.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Reimplemented in QQuickPopupItem, QQuickSwipeDelegate, QQuickSwitch, and QQuickSwitchDelegate.

Definition at line 2011 of file qquickcontrol.cpp.

◆ mousePressEvent()

void QQuickControl::mousePressEvent ( QMouseEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive mouse press events for an item.

The event information is provided by the event parameter.

In order to receive mouse press events, \l acceptedMouseButtons() must return the relevant mouse button.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Reimplemented in QQuickDial, QQuickPopupItem, QQuickRangeSlider, QQuickScrollBar, QQuickSlider, QQuickSwipeDelegate, and QQuickTreeViewDelegate.

Definition at line 2005 of file qquickcontrol.cpp.

◆ mouseReleaseEvent()

void QQuickControl::mouseReleaseEvent ( QMouseEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive mouse release events for an item.

The event information is provided by the event parameter.

In order to receive mouse release events, the preceding mouse press event must be accepted (by overriding \l mousePressEvent(), for example) and \l acceptedMouseButtons() must return the relevant mouse button.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Reimplemented in QQuickPopupItem, and QQuickSwipeDelegate.

Definition at line 2017 of file qquickcontrol.cpp.

◆ mouseUngrabEvent()

void QQuickControl::mouseUngrabEvent ( )
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to be notified when a mouse ungrab event has occurred on this item.

Reimplemented from QQuickItem.

Reimplemented in QQuickPopupItem, and QQuickSwipeDelegate.

Definition at line 2023 of file qquickcontrol.cpp.

◆ padding()

qreal QQuickControl::padding ( ) const

\qmlproperty real QtQuick.Controls::Control::padding

This property holds the default padding.

Padding adds a space between each edge of the content item and the background item, effectively controlling the size of the content item. To specify a padding value for a specific edge of the control, set its relevant property:

\list

  • \l {Control::}{leftPadding}
  • \l {Control::}{rightPadding}
  • \l {Control::}{topPadding}
  • \l {Control::}{bottomPadding} \endlist
Note
Different styles may specify the default padding for certain controls in different ways, and these ways may change over time as the design guidelines that the style is based on evolve. To ensure that these changes don't affect the padding values you have specified, it is best to use the most specific properties available. For example, rather than setting the \l padding property:

set each specific property instead:

See also
{Control Layout}, availableWidth, availableHeight, topPadding, leftPadding, rightPadding, bottomPadding

Definition at line 1114 of file qquickcontrol.cpp.

◆ paddingChange()

void QQuickControl::paddingChange ( const QMarginsF & newPadding,
const QMarginsF & oldPadding )
protectedvirtual

◆ paddingChanged

void QQuickControl::paddingChanged ( )
signal

◆ Q_REVISION [1/10]

QQuickControl::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [2/10]

QQuickControl::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [3/10]

QQuickControl::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [4/10]

QQuickControl::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [5/10]

QQuickControl::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [6/10]

QQuickControl::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [7/10]

QQuickControl::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [8/10]

QQuickControl::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [9/10]

QQuickControl::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [10/10]

QQuickControl::Q_REVISION ( 2 ,
5  )
signal

◆ resetBaselineOffset()

void QQuickControl::resetBaselineOffset ( )

Definition at line 1657 of file qquickcontrol.cpp.

◆ resetBottomInset()

void QQuickControl::resetBottomInset ( )

Definition at line 1934 of file qquickcontrol.cpp.

◆ resetBottomPadding()

void QQuickControl::resetBottomPadding ( )

Definition at line 1260 of file qquickcontrol.cpp.

◆ resetFont()

void QQuickControl::resetFont ( )

Definition at line 1042 of file qquickcontrol.cpp.

◆ resetHorizontalPadding()

void QQuickControl::resetHorizontalPadding ( )

Definition at line 1689 of file qquickcontrol.cpp.

◆ resetHoverEnabled()

void QQuickControl::resetHoverEnabled ( )

Definition at line 1488 of file qquickcontrol.cpp.

◆ resetLeftInset()

void QQuickControl::resetLeftInset ( )

Definition at line 1882 of file qquickcontrol.cpp.

◆ resetLeftPadding()

void QQuickControl::resetLeftPadding ( )

Definition at line 1208 of file qquickcontrol.cpp.

◆ resetLocale()

void QQuickControl::resetLocale ( )

Definition at line 1330 of file qquickcontrol.cpp.

◆ resetPadding()

void QQuickControl::resetPadding ( )

Definition at line 1157 of file qquickcontrol.cpp.

◆ resetRightInset()

void QQuickControl::resetRightInset ( )

Definition at line 1908 of file qquickcontrol.cpp.

◆ resetRightPadding()

void QQuickControl::resetRightPadding ( )

Definition at line 1234 of file qquickcontrol.cpp.

◆ resetSpacing()

void QQuickControl::resetSpacing ( )

Definition at line 1295 of file qquickcontrol.cpp.

◆ resetTopInset()

void QQuickControl::resetTopInset ( )

Definition at line 1856 of file qquickcontrol.cpp.

◆ resetTopPadding()

void QQuickControl::resetTopPadding ( )

Definition at line 1182 of file qquickcontrol.cpp.

◆ resetVerticalPadding()

void QQuickControl::resetVerticalPadding ( )

Definition at line 1716 of file qquickcontrol.cpp.

◆ rightInset()

qreal QQuickControl::rightInset ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::Control::rightInset

This property holds the right inset for the background.

See also
{Control Layout}, leftInset

Definition at line 1896 of file qquickcontrol.cpp.

◆ rightPadding()

qreal QQuickControl::rightPadding ( ) const

\qmlproperty real QtQuick.Controls::Control::rightPadding

This property holds the right padding. Unless explicitly set, the value is equal to horizontalPadding.

See also
{Control Layout}, padding, leftPadding, horizontalPadding, availableWidth

Definition at line 1222 of file qquickcontrol.cpp.

◆ rightPaddingChanged

void QQuickControl::rightPaddingChanged ( )
signal

◆ setAccessibleProperty()

bool QQuickControl::setAccessibleProperty ( const char * propertyName,
const QVariant & value )
protected

Definition at line 2199 of file qquickcontrol.cpp.

◆ setBackground()

void QQuickControl::setBackground ( QQuickItem * background)

Definition at line 1555 of file qquickcontrol.cpp.

◆ setBaselineOffset()

void QQuickControl::setBaselineOffset ( qreal offset)

Definition at line 1650 of file qquickcontrol.cpp.

◆ setBottomInset()

void QQuickControl::setBottomInset ( qreal inset)

Definition at line 1928 of file qquickcontrol.cpp.

◆ setBottomPadding()

void QQuickControl::setBottomPadding ( qreal padding)

Definition at line 1254 of file qquickcontrol.cpp.

◆ setContentItem()

void QQuickControl::setContentItem ( QQuickItem * item)

Definition at line 1638 of file qquickcontrol.cpp.

◆ setFocusReason()

void QQuickControl::setFocusReason ( Qt::FocusReason reason)

Definition at line 1391 of file qquickcontrol.cpp.

◆ setFont()

void QQuickControl::setFont ( const QFont & font)

Definition at line 1032 of file qquickcontrol.cpp.

◆ setHorizontalPadding()

void QQuickControl::setHorizontalPadding ( qreal padding)

Definition at line 1683 of file qquickcontrol.cpp.

◆ setHovered()

void QQuickControl::setHovered ( bool hovered)

Definition at line 1435 of file qquickcontrol.cpp.

◆ setHoverEnabled()

void QQuickControl::setHoverEnabled ( bool enabled)

Definition at line 1475 of file qquickcontrol.cpp.

◆ setLeftInset()

void QQuickControl::setLeftInset ( qreal inset)

Definition at line 1876 of file qquickcontrol.cpp.

◆ setLeftPadding()

void QQuickControl::setLeftPadding ( qreal padding)

Definition at line 1202 of file qquickcontrol.cpp.

◆ setLocale()

void QQuickControl::setLocale ( const QLocale & locale)

Definition at line 1321 of file qquickcontrol.cpp.

◆ setPadding()

void QQuickControl::setPadding ( qreal padding)

Definition at line 1120 of file qquickcontrol.cpp.

◆ setRightInset()

void QQuickControl::setRightInset ( qreal inset)

Definition at line 1902 of file qquickcontrol.cpp.

◆ setRightPadding()

void QQuickControl::setRightPadding ( qreal padding)

Definition at line 1228 of file qquickcontrol.cpp.

◆ setSpacing()

void QQuickControl::setSpacing ( qreal spacing)

Definition at line 1283 of file qquickcontrol.cpp.

◆ setTopInset()

void QQuickControl::setTopInset ( qreal inset)

Definition at line 1850 of file qquickcontrol.cpp.

◆ setTopPadding()

void QQuickControl::setTopPadding ( qreal padding)

Definition at line 1176 of file qquickcontrol.cpp.

◆ setVerticalPadding()

void QQuickControl::setVerticalPadding ( qreal padding)

Definition at line 1710 of file qquickcontrol.cpp.

◆ setWheelEnabled()

void QQuickControl::setWheelEnabled ( bool enabled)

Definition at line 1515 of file qquickcontrol.cpp.

◆ spacing()

qreal QQuickControl::spacing ( ) const

\qmlproperty real QtQuick.Controls::Control::spacing

This property holds the spacing.

Spacing is useful for controls that have multiple or repetitive building blocks. For example, some styles use spacing to determine the distance between the text and indicator of \l CheckBox. Spacing is not enforced by Control, so each style may interpret it differently, and some may ignore it altogether.

Definition at line 1277 of file qquickcontrol.cpp.

◆ spacingChange()

void QQuickControl::spacingChange ( qreal newSpacing,
qreal oldSpacing )
protectedvirtual

Reimplemented in QQuickPage.

Definition at line 2115 of file qquickcontrol.cpp.

◆ spacingChanged

void QQuickControl::spacingChanged ( )
signal

◆ topInset()

qreal QQuickControl::topInset ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::Control::topInset

This property holds the top inset for the background.

See also
{Control Layout}, bottomInset

Definition at line 1844 of file qquickcontrol.cpp.

◆ topPadding()

qreal QQuickControl::topPadding ( ) const

\qmlproperty real QtQuick.Controls::Control::topPadding

This property holds the top padding. Unless explicitly set, the value is equal to verticalPadding.

See also
{Control Layout}, padding, bottomPadding, verticalPadding, availableHeight

Definition at line 1170 of file qquickcontrol.cpp.

◆ topPaddingChanged

void QQuickControl::topPaddingChanged ( )
signal

◆ verticalPadding()

qreal QQuickControl::verticalPadding ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::Control::verticalPadding

This property holds the vertical padding. Unless explicitly set, the value is equal to padding.

See also
{Control Layout}, padding, topPadding, bottomPadding, horizontalPadding

Definition at line 1704 of file qquickcontrol.cpp.

◆ visualFocusChanged

void QQuickControl::visualFocusChanged ( )
signal

◆ wheelEnabledChanged

void QQuickControl::wheelEnabledChanged ( )
signal

Property Documentation

◆ availableHeight

qreal QQuickControl::availableHeight
read

Definition at line 36 of file qquickcontrol_p.h.

◆ availableWidth

qreal QQuickControl::availableWidth
read

Definition at line 35 of file qquickcontrol_p.h.

◆ background

QQuickItem * QQuickControl::background
readwrite

Definition at line 51 of file qquickcontrol_p.h.

◆ baselineOffset

qreal QQuickControl::baselineOffset
readwrite

Definition at line 53 of file qquickcontrol_p.h.

◆ bottomInset

qreal QQuickControl::bottomInset
readwrite

Definition at line 64 of file qquickcontrol_p.h.

◆ bottomPadding

qreal QQuickControl::bottomPadding
readwrite

Definition at line 41 of file qquickcontrol_p.h.

◆ contentItem

QQuickItem * QQuickControl::contentItem
readwrite

Definition at line 52 of file qquickcontrol_p.h.

◆ focusReason

Qt::FocusReason QQuickControl::focusReason
readwrite

Definition at line 46 of file qquickcontrol_p.h.

◆ font

QFont QQuickControl::font
readwrite

Definition at line 34 of file qquickcontrol_p.h.

◆ horizontalPadding

qreal QQuickControl::horizontalPadding
readwrite

Definition at line 55 of file qquickcontrol_p.h.

◆ hovered

bool QQuickControl::hovered
read

Definition at line 48 of file qquickcontrol_p.h.

◆ hoverEnabled

bool QQuickControl::hoverEnabled
readwrite

Definition at line 49 of file qquickcontrol_p.h.

◆ implicitBackgroundHeight

qreal QQuickControl::implicitBackgroundHeight
read

Definition at line 60 of file qquickcontrol_p.h.

◆ implicitBackgroundWidth

qreal QQuickControl::implicitBackgroundWidth
read

Definition at line 59 of file qquickcontrol_p.h.

◆ implicitContentHeight

qreal QQuickControl::implicitContentHeight
read

Definition at line 58 of file qquickcontrol_p.h.

◆ implicitContentWidth

qreal QQuickControl::implicitContentWidth
read

Definition at line 57 of file qquickcontrol_p.h.

◆ leftInset

qreal QQuickControl::leftInset
readwrite

Definition at line 62 of file qquickcontrol_p.h.

◆ leftPadding

qreal QQuickControl::leftPadding
readwrite

Definition at line 39 of file qquickcontrol_p.h.

◆ locale

QLocale QQuickControl::locale
readwrite

Definition at line 43 of file qquickcontrol_p.h.

◆ mirrored

bool QQuickControl::mirrored
read

Definition at line 44 of file qquickcontrol_p.h.

◆ padding

qreal QQuickControl::padding
readwrite

Definition at line 37 of file qquickcontrol_p.h.

◆ rightInset

qreal QQuickControl::rightInset
readwrite

Definition at line 63 of file qquickcontrol_p.h.

◆ rightPadding

qreal QQuickControl::rightPadding
readwrite

Definition at line 40 of file qquickcontrol_p.h.

◆ spacing

qreal QQuickControl::spacing
readwrite

Definition at line 42 of file qquickcontrol_p.h.

◆ topInset

qreal QQuickControl::topInset
readwrite

Definition at line 61 of file qquickcontrol_p.h.

◆ topPadding

qreal QQuickControl::topPadding
readwrite

Definition at line 38 of file qquickcontrol_p.h.

◆ verticalPadding

qreal QQuickControl::verticalPadding
readwrite

Definition at line 56 of file qquickcontrol_p.h.

◆ visualFocus

bool QQuickControl::visualFocus
read

Definition at line 47 of file qquickcontrol_p.h.

◆ wheelEnabled

bool QQuickControl::wheelEnabled
readwrite

Definition at line 50 of file qquickcontrol_p.h.


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