QAbstractState

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

Inherited by: QFinalState, QHistoryState, QState, QStateMachine

New in version 4.6.

Synopsis

Functions

• def active ()

• def machine ()

• def parentState ()

Virtual functions

• def onEntry (event)

• def onExit (event)

Signals

• def activeChanged (active)

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

class PySide2.QtCore.QAbstractState([parent=None])

param parent:

PySide2.QtCore.QState

Constructs a new state with the given parent state.

PySide2.QtCore.QAbstractState.active()

Return type:

bool

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

PySide2.QtCore.QAbstractState.activeChanged(active)

Parameters:

active – bool

PySide2.QtCore.QAbstractState.machine()

Return type:

PySide2.QtCore.QStateMachine

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

PySide2.QtCore.QAbstractState.onEntry(event)

Parameters:

event – PySide2.QtCore.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.

PySide2.QtCore.QAbstractState.onExit(event)

Parameters:

event – PySide2.QtCore.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.

PySide2.QtCore.QAbstractState.parentState()

Return type:

PySide2.QtCore.QState

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