QState 類

The QState class provides a general-purpose state for QStateMachine . 更多...

頭：	`#include <QState>`
CMake:	`find_package(Qt6 REQUIRED COMPONENTS StateMachine)` `target_link_libraries(mytarget PRIVATE Qt6::StateMachine)`
qmake:	`QT += statemachine`
繼承：	QAbstractState
繼承者：	QStateMachine

所有成員列錶，包括繼承成員

公共類型

enum	ChildMode { ExclusiveStates, ParallelStates }
enum	RestorePolicy { DontRestoreProperties, RestoreProperties }

特性

childMode : ChildMode
errorState : QAbstractState*
initialState : QAbstractState*

公共函數

	QState (QState * parent = nullptr)
	QState (QState::ChildMode childMode , QState * parent = nullptr)
virtual	~QState ()
QAbstractTransition *	addTransition (QAbstractState * target )
void	addTransition (QAbstractTransition * transition )
QSignalTransition *	addTransition (const QObject * sender , const char * signal , QAbstractState * target )
QSignalTransition *	addTransition (const QObject * sender , PointerToMemberFunction signal , QAbstractState * target )
void	assignProperty (QObject * object , const char * name , const QVariant & value )
QBindable<QState::ChildMode>	bindableChildMode ()
QBindable<QAbstractState *>	bindableErrorState ()
QBindable<QAbstractState *>	bindableInitialState ()
QState::ChildMode	childMode () const
QAbstractState *	errorState () const
QAbstractState *	initialState () const
void	removeTransition (QAbstractTransition * transition )
void	setChildMode (QState::ChildMode mode )
void	setErrorState (QAbstractState * state )
void	setInitialState (QAbstractState * state )
QList<QAbstractTransition *>	過渡 () const

信號

void	childModeChanged ()
void	errorStateChanged ()
void	finished ()
void	initialStateChanged ()
void	propertiesAssigned ()

重實現保護函數

virtual bool	event (QEvent * e ) override
virtual void	onEntry (QEvent * event ) override
virtual void	onExit (QEvent * event ) override

詳細描述

QState objects can have child states, and can have transitions to other states. QState is part of Qt State Machine 框架 .

The addTransition () function adds a transition. The removeTransition () function removes a transition. The 過渡 () function returns the state's outgoing transitions.

The assignProperty () function is used for defining property assignments that should be performed when a state is entered.

Top-level states must be passed a QStateMachine object as their parent state, or added to a state machine using QStateMachine::addState ().

具有子級狀態的狀態

The childMode property determines how child states are treated. For non-parallel state groups, the setInitialState () function must be called to set the initial state. The child states are mutually exclusive states, and the state machine needs to know which child state to enter when the parent state is the target of a transition.

The state emits the QState::finished () signal when a final child state ( QFinalState ) is entered.

The setErrorState () sets the state's error state. The error state is the state that the state machine will transition to if an error is detected when attempting to enter the state (e.g. because no initial state has been set).

成員類型文檔編製

enum QState:: ChildMode

This enum specifies how a state's child states are treated.

常量	值	描述
`QState::ExclusiveStates`	`0`	The child states are mutually exclusive and an initial state must be set by calling QState::setInitialState ().
`QState::ParallelStates`	`1`	The child states are parallel. When the parent state is entered, all its child states are entered in parallel.

enum QState:: RestorePolicy

This enum specifies the restore policy type. The restore policy takes effect when the machine enters a state which sets one or more properties. If the restore policy is set to RestoreProperties, the state machine will save the original value of the property before the new value is set.

Later, when the machine either enters a state which does not set a value for the given property, the property will automatically be restored to its initial value.

Only one initial value will be saved for any given property. If a value for a property has already been saved by the state machine, it will not be overwritten until the property has been successfully restored.

常量	值	描述
`QState::DontRestoreProperties`	`0`	The state machine should not save the initial values of properties and restore them later.
`QState::RestoreProperties`	`1`	The state machine should save the initial values of properties and restore them later.

另請參閱 QStateMachine::globalRestorePolicy and QState::assignProperty ().

特性文檔編製

`[bindable]` childMode : ChildMode

注意： 此特性支持 QProperty 綁定。

This property holds the child mode of this state

此特性的默認值為 QState::ExclusiveStates .

`[bindable]` errorState : QAbstractState *

注意： 此特性支持 QProperty 綁定。

此特性保持此狀態的錯誤狀態

`[bindable]` initialState : QAbstractState *

注意： 此特性支持 QProperty 綁定。

This property holds the initial state of this state (one of its child states)

成員函數文檔編製

QState:: QState ( QState * parent = nullptr)

構造新的狀態采用給定 parent 狀態。

QState:: QState ( QState::ChildMode childMode , QState * parent = nullptr)

構造新的狀態采用給定 childMode 和給定 parent 狀態。

`[virtual noexcept]` QState:: ~QState ()

銷毀此狀態。

QAbstractTransition QState:: addTransition ( QAbstractState target )

Adds an unconditional transition from this state to the given target state, and returns then new transition object.

void QState:: addTransition ( QAbstractTransition * transition )

添加給定 transition 。過渡擁有此狀態因為源。此狀態擁有過渡的所有權。

QSignalTransition QState:: addTransition (const QObject sender , const char * signal , QAbstractState * target )

Adds a transition associated with the given signal 為給定 sender 對象，並返迴新的 QSignalTransition object. The transition has this state as the source, and the given target as the target state.

template <typename PointerToMemberFunction> QSignalTransition QState:: addTransition (const QObject sender , PointerToMemberFunction signal , QAbstractState * target )

這是重載函數。

void QState:: assignProperty ( QObject * object , const char * name , const QVariant & value )

Instructs this state to set the property with the given name 為給定 object 到給定 value when the state is entered.

另請參閱 propertiesAssigned ().

QState::ChildMode QState:: childMode () const

Returns the child mode of this state.

注意： Getter function for property childMode.

另請參閱 setChildMode ().

`[private signal]` void QState:: childModeChanged ()

此信號發射，當 childMode 特性改變。

注意： 這是私有信號。它可以用於信號連接，但不能由用戶發射。

注意： 通知程序信號對於特性 childMode .

另請參閱 QState::childMode .

QAbstractState *QState:: errorState () const

Returns this state's error state.

注意： Getter function for property errorState.

另請參閱 setErrorState () 和 QStateMachine::error ().

`[private signal]` void QState:: errorStateChanged ()

此信號發射，當 errorState 特性改變。

注意： 這是私有信號。它可以用於信號連接，但不能由用戶發射。

注意： 通知程序信號對於特性 errorState .

另請參閱 QState::errorState .

`[override virtual protected]` bool QState:: event ( QEvent * e )

重實現： QAbstractState::event (QEvent *e).

`[private signal]` void QState:: finished ()

This signal is emitted when a final child state of this state is entered.

注意： 這是私有信號。它可以用於信號連接，但不能由用戶發射。

另請參閱 QFinalState .

QAbstractState *QState:: initialState () const

Returns this state's initial state, or nullptr if the state has no initial state.

注意： Getter function for property initialState.

另請參閱 setInitialState ().

`[private signal]` void QState:: initialStateChanged ()

此信號發射，當 initialState 特性改變。

注意： 這是私有信號。它可以用於信號連接，但不能由用戶發射。

注意： 通知程序信號對於特性 initialState .

另請參閱 QState::initialState .

`[override virtual protected]` void QState:: onEntry ( QEvent * event )

重實現： QAbstractState::onEntry (QEvent *event).

`[override virtual protected]` void QState:: onExit ( QEvent * event )

重實現： QAbstractState::onExit (QEvent *event).

`[private signal]` void QState:: propertiesAssigned ()

This signal is emitted when all properties have been assigned their final value. If the state assigns a value to one or more properties for which an animation exists (either set on the transition or as a default animation on the state machine), then the signal will not be emitted until all such animations have finished playing.

If there are no relevant animations, or no property assignments defined for the state, then the signal will be emitted immediately before the state is entered.

另請參閱 QState::assignProperty () 和 QAbstractTransition::addAnimation ()

注意： 這是私有信號。它可以用於信號連接，但不能由用戶發射。

void QState:: removeTransition ( QAbstractTransition * transition )

移除給定 transition from this state. The state releases ownership of the transition.

另請參閱 addTransition ().

void QState:: setChildMode ( QState::ChildMode mode )

設置子級 mode of this state.

注意： setter 函數對於特性 childMode .

另請參閱 childMode ().

void QState:: setErrorState ( QAbstractState * state )

Sets this state's error state to be the given state . If the error state is not set, or if it is set to nullptr , the state will inherit its parent's error state recursively. If no error state is set for the state itself or any of its ancestors, an error will cause the machine to stop executing and an error will be printed to the console.

注意： setter 函數對於特性 errorState .

另請參閱 errorState ().

void QState:: setInitialState ( QAbstractState * state )

Sets this state's initial state to be the given state . state has to be a child of this state.

注意： setter 函數對於特性 initialState .

另請參閱 initialState ().

QList < QAbstractTransition *> QState:: 過渡 () const

Returns this state's outgoing transitions (i.e. transitions where this state is the source state ), or an empty list if this state has no outgoing transitions.

另請參閱 addTransition ().

QState 類

公共類型

特性

公共函數

信號

重實現保護函數

詳細描述

具有子級狀態的狀態

成員類型文檔編製

enum QState:: ChildMode

enum QState:: RestorePolicy

特性文檔編製

[bindable] childMode : ChildMode

[bindable] errorState : QAbstractState *

[bindable] initialState : QAbstractState *

成員函數文檔編製

QState:: QState ( QState * parent = nullptr)

QState:: QState ( QState::ChildMode childMode , QState * parent = nullptr)

[virtual noexcept] QState:: ~QState ()

QAbstractTransition *QState:: addTransition ( QAbstractState * target )

void QState:: addTransition ( QAbstractTransition * transition )

QSignalTransition *QState:: addTransition (const QObject * sender , const char * signal , QAbstractState * target )

template <typename PointerToMemberFunction> QSignalTransition *QState:: addTransition (const QObject * sender , PointerToMemberFunction signal , QAbstractState * target )

void QState:: assignProperty ( QObject * object , const char * name , const QVariant & value )

QState::ChildMode QState:: childMode () const

[private signal] void QState:: childModeChanged ()

QAbstractState *QState:: errorState () const

[private signal] void QState:: errorStateChanged ()

[override virtual protected] bool QState:: event ( QEvent * e )

[private signal] void QState:: finished ()

QAbstractState *QState:: initialState () const

[private signal] void QState:: initialStateChanged ()

[override virtual protected] void QState:: onEntry ( QEvent * event )

[override virtual protected] void QState:: onExit ( QEvent * event )

[private signal] void QState:: propertiesAssigned ()

void QState:: removeTransition ( QAbstractTransition * transition )

void QState:: setChildMode ( QState::ChildMode mode )

void QState:: setErrorState ( QAbstractState * state )

void QState:: setInitialState ( QAbstractState * state )

QList < QAbstractTransition *> QState:: 過渡 () const

內容

`[bindable]` childMode : ChildMode

`[bindable]` errorState : QAbstractState *

`[bindable]` initialState : QAbstractState *

`[virtual noexcept]` QState:: ~QState ()

QAbstractTransition QState:: addTransition ( QAbstractState target )

QSignalTransition QState:: addTransition (const QObject sender , const char * signal , QAbstractState * target )

template <typename PointerToMemberFunction> QSignalTransition QState:: addTransition (const QObject sender , PointerToMemberFunction signal , QAbstractState * target )

`[private signal]` void QState:: childModeChanged ()

`[private signal]` void QState:: errorStateChanged ()

`[override virtual protected]` bool QState:: event ( QEvent * e )

`[private signal]` void QState:: finished ()

`[private signal]` void QState:: initialStateChanged ()

`[override virtual protected]` void QState:: onEntry ( QEvent * event )

`[override virtual protected]` void QState:: onExit ( QEvent * event )

`[private signal]` void QState:: propertiesAssigned ()