 |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
|
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
#include <qqstylekitcontrol_p.h>
Public Member Functions | |
| QQStyleKitControl (QObject *parent=nullptr) | |
| \qmltype ControlStyle \inqmlmodule Qt.labs.StyleKit \inherits ControlStateStyle | |
| QQmlListProperty< QQStyleKitVariation > | variations () |
| Public Member Functions inherited from QQStyleKitControlState | |
| QQStyleKitControlState (QObject *parent=nullptr) | |
| QQStyleKitControlState * | pressed () const |
| QQStyleKitControlState * | hovered () const |
| QQStyleKitControlState * | focused () const |
| QQStyleKitControlState * | checked () const |
| QQStyleKitControlState * | disabled () const |
| QQStyleKitControlState * | highlighted () const |
| QQStyleKitControlState * | vertical () const |
| QQStyleKitControl * | control () const |
| QQSK::State | nestedState () const |
| Public Member Functions inherited from QQStyleKitControlProperties | |
| QQStyleKitControlProperties (QQSK::PropertyGroup group, QObject *parent=nullptr) | |
| void | emitChangedForAllStyleProperties (EmitFlags emitFlags) |
| template<typename... CHANGED_SIGNALS> | |
| void | emitGlobally (QQStyleKitExtendableControlType controlType, CHANGED_SIGNALS... changedSignals) const |
| void | forEachUsedDelegate (std::function< void(QQStyleKitDelegateProperties *, QQSK::Delegate, const QString &)> f) |
| QQStyleKitStyle * | style () const |
| QQSK::Subclass | subclass () const |
| QQStyleKitReader * | asQQStyleKitReader () const |
| QQStyleKitControlState * | asQQStyleKitState () const |
| qreal | spacing () const |
| void | setSpacing (qreal spacing) |
| qreal | padding () const |
| void | setPadding (qreal padding) |
| qreal | leftPadding () const |
| void | setLeftPadding (qreal leftPadding) |
| qreal | rightPadding () const |
| void | setRightPadding (qreal rightPadding) |
| qreal | topPadding () const |
| void | setTopPadding (qreal topPadding) |
| qreal | bottomPadding () const |
| void | setBottomPadding (qreal bottomPadding) |
| QQuickTransition * | transition () const |
| void | setTransition (QQuickTransition *transition) |
| QQStyleKitTextProperties * | text () const |
| QQStyleKitDelegateProperties * | background () const |
| QQStyleKitHandleProperties * | handle () const |
| QQStyleKitIndicatorWithSubTypes * | indicator () const |
| Public Member Functions inherited from QQStyleKitPropertyGroup | |
| QQStyleKitPropertyGroup (QQSK::PropertyGroup group, QObject *parent) | |
| PropertyPathId | propertyPathId (QQSK::Property property, PropertyPathId::Flag flag) const |
| QString | pathToString () const |
| template<typename T> | |
| T | styleProperty (QQSK::Property property, QQSK::Property alternative=QQSK::Property::NoProperty) const |
| template<typename T> | |
| T | styleProperty (QQSK::Property property, const T &defaultValue) const |
| template<typename T> | |
| bool | setStyleProperty (QQSK::Property property, T value) |
| bool | isDefined (QQSK::Property property) const |
| template<typename SUBCLASS> | |
| void | handleStylePropertyChanged (void(SUBCLASS::*changedSignal)()) |
| template<typename SUBCLASS, typename... CHANGED_SIGNALS> | |
| void | handleStylePropertiesChanged (CHANGED_SIGNALS... changedSignals) |
| template<typename T> | |
| T * | lazyCreateGroup (T *const &ptr, QQSK::PropertyGroup group) const |
| bool | isControlProperties () const |
| QQStyleKitControlProperties * | controlProperties () const |
| QQSK::PropertyPathFlags | pathFlags () const |
| void | emitChangedForAllStylePropertiesRecursive (EmitFlags emitFlags) |
| 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 | event (QEvent *event) |
| This virtual function receives events to an object and should return true if the event e was recognized and processed. | |
| virtual bool | eventFilter (QObject *watched, QEvent *event) |
| Filters events if this object has been installed as an event filter for the watched object. | |
| QString | objectName () const |
| Q_WEAK_OVERLOAD void | setObjectName (const QString &name) |
| Sets the object's name to name. | |
| void | setObjectName (QAnyStringView name) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| QBindable< QString > | bindableObjectName () |
| bool | isWidgetType () const |
Returns true if the object is a widget; otherwise returns false. | |
| bool | isWindowType () const |
Returns true if the object is a window; otherwise returns false. | |
| bool | isQuickItemType () const |
Returns true if the object is a QQuickItem; otherwise returns false. | |
| bool | isQmlExposed () const noexcept |
| Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership(). | |
| bool | signalsBlocked () const noexcept |
Returns true if signals are blocked; otherwise returns false. | |
| bool | blockSignals (bool b) noexcept |
| If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). | |
| QThread * | thread () const |
| Returns the thread in which the object lives. | |
| bool | moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL) |
Changes the thread affinity for this object and its children and returns true on success. | |
| int | startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer) |
| This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds. | |
| int | startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer) |
| void | killTimer (int id) |
| Kills the timer with timer identifier, id. | |
| void | killTimer (Qt::TimerId id) |
| template<typename T> | |
| T | findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object. | |
| template<typename T> | |
| QList< T > | findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. | |
| template<typename T> | |
| T | findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| template<typename T> | |
| QList< T > | findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| const QObjectList & | children () const |
| Returns a list of child objects. | |
| void | setParent (QObject *parent) |
| Makes the object a child of parent. | |
| void | installEventFilter (QObject *filterObj) |
| Installs an event filter filterObj on this object. | |
| void | removeEventFilter (QObject *obj) |
| Removes an event filter object obj from this object. | |
| QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const |
| bool | disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const |
| bool | disconnect (const QObject *receiver, const char *member=nullptr) const |
| void | dumpObjectTree () const |
| Dumps a tree of children to the debug output. | |
| void | dumpObjectInfo () const |
| Dumps information about signal connections, etc. | |
| bool | setProperty (const char *name, const QVariant &value) |
| Sets the value of the object's name property to value. | |
| bool | setProperty (const char *name, QVariant &&value) |
| QVariant | property (const char *name) const |
| Returns the value of the object's name property. | |
| QList< QByteArray > | dynamicPropertyNames () const |
| QBindingStorage * | bindingStorage () |
| const QBindingStorage * | bindingStorage () const |
| QObject * | parent () const |
| Returns a pointer to the parent object. | |
| bool | inherits (const char *classname) const |
Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. | |
Properties | |
| QQmlListProperty< QQStyleKitVariation > | variations |
| Properties inherited from QQStyleKitControlState | |
| QQStyleKitControlState * | pressed |
| QQStyleKitControlState * | hovered |
| QQStyleKitControlState * | focused |
| QQStyleKitControlState * | checked |
| QQStyleKitControlState * | disabled |
| QQStyleKitControlState * | highlighted |
| QQStyleKitControlState * | vertical |
| Properties inherited from QQStyleKitControlProperties | |
| qreal | spacing |
| qreal | padding |
| qreal | leftPadding |
| qreal | rightPadding |
| qreal | topPadding |
| qreal | bottomPadding |
| QQStyleKitDelegateProperties * | background |
| QQStyleKitHandleProperties * | handle |
| QQStyleKitIndicatorWithSubTypes * | indicator |
| QQStyleKitTextProperties * | text |
| QQuickTransition * | transition |
| Properties inherited from QObject | |
| QString | objectName |
| the name of this object | |
Friends | |
| class | QQStyleKitPropertyResolver |
| class | QQStyleKitPropertyGroup |
| class | QQStyleKitControls |
Additional Inherited Members | |
| Public Types inherited from QQStyleKitPropertyGroup | |
| enum class | EmitFlag { AllProperties , Colors } |
| Public Slots inherited from QObject | |
| void | deleteLater () |
| \threadsafe | |
| Signals inherited from QQStyleKitControlState | |
| void | pressedChanged () |
| void | hoveredChanged () |
| void | focusedChanged () |
| void | checkedChanged () |
| void | disabledChanged () |
| void | highlightedChanged () |
| void | verticalChanged () |
| Signals inherited from QQStyleKitControlProperties | |
| void | backgroundChanged () |
| void | handleChanged () |
| void | indicatorChanged () |
| void | spacingChanged () |
| void | paddingChanged () |
| void | leftPaddingChanged () |
| void | rightPaddingChanged () |
| void | topPaddingChanged () |
| void | bottomPaddingChanged () |
| void | transitionChanged () |
| void | textChanged () |
| 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. | |
| 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 Member Functions inherited from QObject | |
| QObject * | sender () const |
| Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr. | |
| int | senderSignalIndex () const |
| int | receivers (const char *signal) const |
| Returns the number of receivers connected to the signal. | |
| bool | isSignalConnected (const QMetaMethod &signal) const |
| virtual void | timerEvent (QTimerEvent *event) |
| This event handler can be reimplemented in a subclass to receive timer events for the object. | |
| virtual void | childEvent (QChildEvent *event) |
| This event handler can be reimplemented in a subclass to receive child events. | |
| virtual void | customEvent (QEvent *event) |
| This event handler can be reimplemented in a subclass to receive custom events. | |
| virtual void | connectNotify (const QMetaMethod &signal) |
| virtual void | disconnectNotify (const QMetaMethod &signal) |
| QObject (QObjectPrivate &dd, QObject *parent=nullptr) | |
| Protected Attributes inherited from QQStyleKitPropertyGroup | |
| QQStyleKitPropertyGroupSpace | m_groupSpace |
| QQSK::PropertyPathFlags | m_pathFlags = QQSK::PropertyPathFlag::NoFlags |
| Protected Attributes inherited from QObject | |
| QScopedPointer< QObjectData > | d_ptr |
| Related Symbols inherited from QObject | |
| template< class T > T | qobject_cast (const QObject *object) |
| Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr. | |
| template< typename T > T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
| template< typename T > QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
| QObjectList | |
| \macro Q_CLASSINFO(Name, Value) | |
Definition at line 28 of file qqstylekitcontrol_p.h.
| QT_BEGIN_NAMESPACE QQStyleKitControl::QQStyleKitControl | ( | QObject * | parent = nullptr | ) |
\qmltype ControlStyle \inqmlmodule Qt.labs.StyleKit \inherits ControlStateStyle
Defines the style for a control in the normal state
A ControlStyle describes how a \l Control should be styled. Its API largely mirrors that of a Qt Quick Control: it provides grouped properties for delegates such as \l {ControlState::background}{background}, \l {ControlState::indicator}{indicator}, \l {ControlState::handle}{handle}, and \l {ControlState::text}{text}, along with layout properties such as \l {ControlState::padding}{padding} and \l {ControlState::spacing}{spacing}. If you are familiar with the API of a \l Control in Qt Quick Controls, you should find the ControlStyle API easy to follow.
ControlStyle inherits \l ControlStateStyle because it represents the normal state: properties set directly on a ControlStyle describe how the control looks when no other state is active. State-specific overrides are set through nested states, such as \l {ControlStateStyle::}{hovered} \l {ControlStateStyle::}{pressed}, and \l {ControlStateStyle::}{checked}.
\l {AbstractStylableControls}{Each stylable control} in a \l Style, \l Theme, or \l StyleVariation is a ControlStyle. For example, in the snippet below, \l {AbstractStylableControls::}{control}, \l {AbstractStylableControls::}{button} and \l {AbstractStylableControls::}{radioButton} are all ControlStyles:
\qmlproperty list<StyleVariation> ControlStyle::variations
A list of \l {StyleVariation}{type variations} for this control type.
A type variation provides alternate styling for controls that are children (or descendants) of this control type. For example, you can use it to style all \l {Button}{buttons} inside a \l {Frame}{frame} differently from buttons elsewhere:
You can also set it back to an empty list for a subtype, if you don't want it to inherit the variations set on a base type:
Unlike instance variations — which are applied to specific control instances from the application via the \l {StyleVariation.variations} attached property — type variations are applied to {all} instances of a control type from the \l Style, without requiring the application to opt in.
Definition at line 72 of file qqstylekitcontrol.cpp.
References QObjectData::parent.
| QQmlListProperty< QQStyleKitVariation > QQStyleKitControl::variations | ( | ) |
|
friend |
Definition at line 55 of file qqstylekitcontrol_p.h.
|
friend |
Definition at line 54 of file qqstylekitcontrol_p.h.
|
friend |
Definition at line 53 of file qqstylekitcontrol_p.h.
|
read |
Definition at line 31 of file qqstylekitcontrol_p.h.
1.16.1