#include <qquickstategroup_p.h>

Inheritance diagram for QQuickStateGroup:

Collaboration diagram for QQuickStateGroup:

Signals
void	stateChanged (const QString &)
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
	QQuickStateGroup (QObject *=nullptr)
	\qmltype StateGroup \nativetype QQuickStateGroup \inqmlmodule QtQuick
virtual	~QQuickStateGroup ()
QString	state () const
	\qmlproperty string QtQuick::StateGroup::state
void	setState (const QString &)
QQmlListProperty< QQuickState >	statesProperty ()
	\qmlproperty list<State> QtQuick::StateGroup::states This property holds a list of states defined by the state group.
QList< QQuickState * >	states () const
QQmlListProperty< QQuickTransition >	transitionsProperty ()
	\qmlproperty list<Transition> QtQuick::StateGroup::transitions This property holds a list of transitions defined by the state group.
QQuickState *	findState (const QString &name) const
void	removeState (QQuickState *state)
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.
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	isQmlObjectType () const
	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`.
Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()
virtual	~QQmlParserStatus ()

Properties
QString	state
QQmlListProperty< QQuickState >	states
QQmlListProperty< QQuickTransition >	transitions
Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QQuickState
class	QQuickStatePrivate

Additional Inherited Members
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 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)

Detailed Description

Definition at line 24 of file qquickstategroup_p.h.

Constructor & Destructor Documentation

◆ QQuickStateGroup()

QQuickStateGroup::QQuickStateGroup ( QObject * parent = nullptr )

\qmltype StateGroup \nativetype QQuickStateGroup \inqmlmodule QtQuick

Provides built-in state support for non-Item types.

Item (and all derived types) provides built in support for states and transitions via its \l{Item::state}{state}, \l{Item::states}{states} and \l{Item::transitions}{transitions} properties. StateGroup provides an easy way to use this support in other (non-Item-derived) types.

\qml MyCustomObject { StateGroup { id: myStateGroup states: State { name: "state1" ... } transitions: Transition { ... } }

onSomethingHappened: myStateGroup.state = "state1"; } \endqml

See also: {Qt Quick States}{Qt Quick States}, {Animation and Transitions in Qt Quick}{Transitions}, {Qt Qml}

Definition at line 90 of file qquickstategroup.cpp.

◆ ~QQuickStateGroup()

QQuickStateGroup::~QQuickStateGroup ( )

virtual

Definition at line 95 of file qquickstategroup.cpp.

Member Function Documentation

◆ classBegin()

void QQuickStateGroup::classBegin ( )

overridevirtual

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

Implements QQmlParserStatus.

Definition at line 297 of file qquickstategroup.cpp.

◆ componentComplete()

void QQuickStateGroup::componentComplete ( )

overridevirtual

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.

Definition at line 303 of file qquickstategroup.cpp.

◆ findState()

QQuickState * QQuickStateGroup::findState ( const QString & name ) const

Definition at line 517 of file qquickstategroup.cpp.

◆ removeState()

void QQuickStateGroup::removeState ( QQuickState * state )

Definition at line 528 of file qquickstategroup.cpp.

◆ setState()

void QQuickStateGroup::setState ( const QString & state )

Definition at line 288 of file qquickstategroup.cpp.

◆ state()

QString QQuickStateGroup::state ( ) const

\qmlproperty string QtQuick::StateGroup::state

This property holds the name of the current state of the state group.

This property is often used in scripts to change between states. For example:

\qml function toggle() { if (button.state == 'On') button.state = 'Off'; else button.state = 'On'; } \endqml

If the state group is in its base state (i.e. no explicit state has been set), state will be a blank string. Likewise, you can return a state group to its base state by setting its current state to ''.

See also: {Qt Quick States}{Qt Quick States}

Definition at line 282 of file qquickstategroup.cpp.

◆ stateChanged

void QQuickStateGroup::stateChanged ( const QString & )

signal

◆ states()

QList< QQuickState * > QQuickStateGroup::states ( ) const

Definition at line 106 of file qquickstategroup.cpp.

◆ statesProperty()

QQmlListProperty< QQuickState > QQuickStateGroup::statesProperty ( )

\qmlproperty list<State> QtQuick::StateGroup::states This property holds a list of states defined by the state group.

\qml StateGroup { states: [ State { State definition... }, State { ... } Other states... ] } \endqml

See also: {Qt Quick States}{Qt Quick States}

Definition at line 132 of file qquickstategroup.cpp.

◆ transitionsProperty()

QQmlListProperty< QQuickTransition > QQuickStateGroup::transitionsProperty ( )

\qmlproperty list<Transition> QtQuick::StateGroup::transitions This property holds a list of transitions defined by the state group.

\qml StateGroup { transitions: [ Transition { ... }, Transition { ... } ... ] } \endqml

See also: {Animation and Transitions in Qt Quick}{Transitions}

Definition at line 225 of file qquickstategroup.cpp.

◆ QQuickState

friend class QQuickState

friend

Definition at line 57 of file qquickstategroup_p.h.

◆ QQuickStatePrivate

friend class QQuickStatePrivate

friend

Definition at line 58 of file qquickstategroup_p.h.

Property Documentation

◆ state

QString QQuickStateGroup::state

readwrite

Definition at line 30 of file qquickstategroup_p.h.

◆ states

QQmlListProperty<QQuickState> QQuickStateGroup::states

read

Definition at line 31 of file qquickstategroup_p.h.

◆ transitions

QQmlListProperty<QQuickTransition> QQuickStateGroup::transitions