PySide6.QtStateMachine.QAbstractState

class QAbstractState

The QAbstractState class is the base class of states of a QStateMachine . More…

Inherited by: QState, QStateMachine, QHistoryState, QFinalState

Synopsis

Properties

• activeᅟ - The active property of this state. A state is active between entered() and exited() signals

Methods

• def __init__()

• def active()

• def machine()

• def parentState()

Virtual methods

• def onEntry()

• def onExit()

Signals

• def activeChanged()

• def entered()

• def exited()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

The QAbstractState class is the abstract base class of states that are part of a QStateMachine . It defines the interface that all state objects have in common. QAbstractState is part of Qt State Machine Framework .

The entered() signal is emitted when the state has been entered. The exited() signal is emitted when the state has been exited.

The parentState() function returns the state’s parent state. The machine() function returns the state machine that the state is part of.

Subclassing

The onEntry() function is called when the state is entered; reimplement this function to perform custom processing when the state is entered.

The onExit() function is called when the state is exited; reimplement this function to perform custom processing when the state is exited.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property activeᅟ: bool

This property holds the active property of this state. A state is active between entered() and exited() signals..

Access functions:

• active()

• Signal activeChanged()

__init__([parent=None])

Parameters:

parent – QState

Constructs a new state with the given parent state.

active()

Return type:

bool

Returns whether this state is active.

See also

activeChanged(bool) entered() exited()

Getter of property activeᅟ .

activeChanged(active)

Parameters:

active – bool

This signal is emitted when the active property is changed with active as argument.

See also

QAbstractState::active entered() exited()

Notification signal of property activeᅟ .

entered()

This signal is emitted when the state has been entered (after onEntry() has been called).

exited()

This signal is emitted when the state has been exited (after onExit() has been called).

machine()

Return type:

QStateMachine

Returns the state machine that this state is part of, or None if the state is not part of a state machine.

abstract onEntry(event)

Parameters:

event – QEvent

This function is called when the state is entered. The given event is what caused the state to be entered. Reimplement this function to perform custom processing when the state is entered.

abstract onExit(event)

Parameters:

event – QEvent

This function is called when the state is exited. The given event is what caused the state to be exited. Reimplement this function to perform custom processing when the state is exited.

parentState()

Return type:

QState

Returns this state’s parent state, or None if the state has no parent state.