Member Function Documentation

QState::QState(QState *parent = nullptr)

Constructs a new state with the given parent state.

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

Constructs a new state with the given childMode and the given parent state.

[virtual] QState::~QState()

Destroys this state.

void QState::addTransition(QAbstractTransition *transition)

Adds the given transition. The transition has this state as the source. This state takes ownership of the transition.

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

Adds a transition associated with the given signal of the given sender object, and returns the new QSignalTransition object. The transition has this state as the source, and the given target as the target state.

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

This is an overloaded function.

Adds a transition associated with the given signal of the given sender object, and returns the new QSignalTransition object. The transition has this state as the source, and the given target as the target state.

This function was introduced in Qt 5.5.

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::assignProperty(QObject *object, const char *name, const QVariant &value)

Instructs this state to set the property with the given name of the given object to the given value when the state is entered.

See also propertiesAssigned().

QState::ChildMode QState::childMode() const

Returns the child mode of this state.

Note: Getter function for property childMode.

See also setChildMode().

[signal] void QState::childModeChanged()

This signal is emitted when the childMode property is changed.

This function was introduced in Qt 5.4.

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

Note: Notifier signal for property childMode.

See also QState::childMode.

QAbstractState *QState::errorState() const

Returns this state's error state.

Note: Getter function for property errorState.

See also setErrorState() and QStateMachine::error().

[signal] void QState::errorStateChanged()

This signal is emitted when the errorState property is changed.

This function was introduced in Qt 5.4.

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

Note: Notifier signal for property errorState.

See also QState::errorState.

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

Reimplemented from QAbstractState::event().

[signal] void QState::finished()

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

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

See also QFinalState.

QAbstractState *QState::initialState() const

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

Note: Getter function for property initialState.

See also setInitialState().

[signal] void QState::initialStateChanged()

This signal is emitted when the initialState property is changed.

This function was introduced in Qt 5.4.

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

Note: Notifier signal for property initialState.

See also QState::initialState.

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

Reimplemented from QAbstractState::onEntry().

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

Reimplemented from QAbstractState::onExit().

[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.

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

See also QState::assignProperty() and QAbstractTransition::addAnimation().

void QState::removeTransition(QAbstractTransition *transition)

Removes the given transition from this state. The state releases ownership of the transition.

See also addTransition().

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

Sets the child mode of this state.

Note: Setter function for property childMode.

See also 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 0, 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.

Note: Setter function for property errorState.

See also 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.

Note: Setter function for property initialState.

See also initialState().

QList<QAbstractTransition *> QState::transitions() 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.

This function was introduced in Qt 4.7.

See also addTransition().