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

#include <qqstylekitcontrolstate_p.h>

Inheritance diagram for QQStyleKitControlState:
Collaboration diagram for QQStyleKitControlState:

Signals

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.

Public Member Functions

 QQStyleKitControlState (QObject *parent=nullptr)
 \qmltype ControlStateStyle \inqmlmodule Qt.labs.StyleKit \inherits ControlStyleProperties
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

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

Additional Inherited Members

Public Types inherited from QQStyleKitPropertyGroup
enum class  EmitFlag { AllProperties , Colors }
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)
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
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 \macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 27 of file qqstylekitcontrolstate_p.h.

Constructor & Destructor Documentation

◆ QQStyleKitControlState()

QT_BEGIN_NAMESPACE QQStyleKitControlState::QQStyleKitControlState ( QObject * parent = nullptr)

\qmltype ControlStateStyle \inqmlmodule Qt.labs.StyleKit \inherits ControlStyleProperties

Describes the style of a control in a given state.

ControlStateStyle describes the style of a control in a particular state. A \l ControlStyle inherits ControlStateStyle, since it represents the normal state — properties set directly on a \l ControlStyle describe how the control looks when no other state is active. State-specific overrides are then set through nested states such as \l pressed, \l hovered, and \l checked.

Nested states are not mutually exclusive. Multiple states can be active at the same time — for example, a button can be both hovered and pressed simultaneously. When several states are active, all matching state overrides are applied. If the same property is set in multiple active states, conflicts are resolved using the following priority order: \l pressed, \l hovered, \l highlighted, \l focused, \l checked, \l vertical. So for example {pressed.background.color} wins over {checked.background.color} if the control is both \l pressed and \l checked.

The \l disabled state is an exception: a disabled control cannot be interacted with, so the \l pressed, \l hovered, \l highlighted, and \l focused states will not apply. However, \l disabled can still be combined with states like \l checked and \l vertical.

The more deeply nested a state is, the more qualified it is. For example, {hovered.pressed.background.color} takes precedence over {hovered.background.color} when both \l hovered and \l pressed are active. The nesting order does not matter: {hovered.pressed} and {pressed.hovered} are equivalent. However, if both forms are used at the same time, which one wins is undefined.

Deeper nesting of states can also be used to resolve conflicts. If the same property is set in both \l hovered and \l checked, the priority order means the \l hovered value wins. If you would rather have the checked value win, or use an altogether different value in that situation, you can override the property in {hovered.checked}, which then takes precedence over both.

The following snippet shows how to style a button differently depending on its state:

\labs

See also
ControlStyle, DelegateStyle, {qtlabsstylekit-fallbackstyle.html}{FallbackStyle Reference}

\qmlproperty ControlStateStyle ControlStateStyle::pressed

Style overrides applied when the control is \l {StyleReader::}{pressed}.

See also
hovered, highlighted, focused, checked, vertical, disabled, {StyleReader::pressed}{StyleReader.pressed}

\qmlproperty ControlStateStyle ControlStateStyle::hovered

Style overrides applied when the control is \l {StyleReader::}{hovered}.

See also
pressed, highlighted, focused, checked, vertical, disabled, {StyleReader::hovered}{StyleReader.hovered}

\qmlproperty ControlStateStyle ControlStateStyle::highlighted

Style overrides applied when the control is \l {StyleReader::}{highlighted}.

See also
pressed, hovered, focused, checked, vertical, disabled, {StyleReader::highlighted}{StyleReader.highlighted}

\qmlproperty ControlStateStyle ControlStateStyle::focused

Style overrides applied when the control is \l {StyleReader::}{focused}.

See also
pressed, hovered, highlighted, checked, vertical, disabled, {StyleReader::focused}{StyleReader.focused}

\qmlproperty ControlStateStyle ControlStateStyle::checked

Style overrides applied when the control is \l {StyleReader::}{checked}.

See also
pressed, hovered, highlighted, focused, vertical, disabled, {StyleReader::checked}{StyleReader.checked}

\qmlproperty ControlStateStyle ControlStateStyle::vertical

Style overrides applied when the control is \l {StyleReader::}{vertical} (for example, a vertical \l Slider or \l ScrollBar).

See also
pressed, hovered, highlighted, focused, checked, disabled, {StyleReader::vertical}{StyleReader.vertical}

\qmlproperty ControlStateStyle ControlStateStyle::disabled

Style overrides applied when the control is \l {StyleReader::}{disabled}.

A disabled control cannot be interacted with, so \l pressed, \l hovered, \l highlighted, and \l focused will not be applied at the same time as disabled.

See also
pressed, hovered, highlighted, focused, checked, vertical, {StyleReader::enabled}{StyleReader.enabled}

Definition at line 132 of file qqstylekitcontrolstate.cpp.

Member Function Documentation

◆ checked()

QQStyleKitControlState * QQStyleKitControlState::checked ( ) const

Definition at line 184 of file qqstylekitcontrolstate.cpp.

◆ checkedChanged

void QQStyleKitControlState::checkedChanged ( )
signal

◆ control()

QQStyleKitControl * QQStyleKitControlState::control ( ) const

Definition at line 137 of file qqstylekitcontrolstate.cpp.

Referenced by QQStyleKitPropertyResolver::hasLocalStyleProperty(), QQStyleKitPropertyResolver::readStyleProperty(), and QQStyleKitPropertyResolver::writeStyleProperty().

Here is the caller graph for this function:

◆ disabled()

QQStyleKitControlState * QQStyleKitControlState::disabled ( ) const

Definition at line 194 of file qqstylekitcontrolstate.cpp.

◆ disabledChanged

void QQStyleKitControlState::disabledChanged ( )
signal

◆ focused()

QQStyleKitControlState * QQStyleKitControlState::focused ( ) const

Definition at line 179 of file qqstylekitcontrolstate.cpp.

◆ focusedChanged

void QQStyleKitControlState::focusedChanged ( )
signal

◆ highlighted()

QQStyleKitControlState * QQStyleKitControlState::highlighted ( ) const

Definition at line 174 of file qqstylekitcontrolstate.cpp.

◆ highlightedChanged

void QQStyleKitControlState::highlightedChanged ( )
signal

◆ hovered()

QQStyleKitControlState * QQStyleKitControlState::hovered ( ) const

Definition at line 169 of file qqstylekitcontrolstate.cpp.

◆ hoveredChanged

void QQStyleKitControlState::hoveredChanged ( )
signal

◆ nestedState()

QQSK::State QQStyleKitControlState::nestedState ( ) const
inline

Definition at line 51 of file qqstylekitcontrolstate_p.h.

◆ pressed()

QQStyleKitControlState * QQStyleKitControlState::pressed ( ) const

Definition at line 164 of file qqstylekitcontrolstate.cpp.

◆ pressedChanged

void QQStyleKitControlState::pressedChanged ( )
signal

◆ vertical()

QQStyleKitControlState * QQStyleKitControlState::vertical ( ) const

Definition at line 189 of file qqstylekitcontrolstate.cpp.

◆ verticalChanged

void QQStyleKitControlState::verticalChanged ( )
signal

Property Documentation

◆ checked

QQStyleKitControlState * QQStyleKitControlState::checked
read

Definition at line 33 of file qqstylekitcontrolstate_p.h.

◆ disabled

QQStyleKitControlState * QQStyleKitControlState::disabled
read

Definition at line 34 of file qqstylekitcontrolstate_p.h.

◆ focused

QQStyleKitControlState * QQStyleKitControlState::focused
read

Definition at line 32 of file qqstylekitcontrolstate_p.h.

◆ highlighted

QQStyleKitControlState * QQStyleKitControlState::highlighted
read

Definition at line 35 of file qqstylekitcontrolstate_p.h.

◆ hovered

QQStyleKitControlState * QQStyleKitControlState::hovered
read

Definition at line 31 of file qqstylekitcontrolstate_p.h.

◆ pressed

QQStyleKitControlState * QQStyleKitControlState::pressed
read

Definition at line 30 of file qqstylekitcontrolstate_p.h.

◆ vertical

QQStyleKitControlState * QQStyleKitControlState::vertical
read

Definition at line 36 of file qqstylekitcontrolstate_p.h.

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