QState露
- PyQt5.QtCore.QState
Inherits from QAbstractState.
Inherited by QStateMachine.
Description露
The QState class provides a general-purpose state for QStateMachine.
QState objects can have child states, and can have transitions to other states. QState is part of The State Machine Framework.
The addTransition() function adds a transition. The removeTransition() function removes a transition. The transitions() function returns the state鈥檚 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 addState().
States with Child States露
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 finished signal when a final child state (QFinalState) is entered.
The setErrorState() sets the state鈥檚 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).
Enums露
- ChildMode
This enum specifies how a state鈥檚 child states are treated.
Member
Value
Description
ExclusiveStates 0
The child states are mutually exclusive and an initial state must be set by calling setInitialState().
ParallelStates 1
The child states are parallel. When the parent state is entered, all its child states are entered in parallel.
- RestorePolicy
TODO
Member
Value
Description
DontRestoreProperties TODO
TODO
RestoreProperties TODO
TODO
Methods露
- __init__(parent: QState = None)
TODO
- __init__(ChildMode, parent: QState = None)
Constructs a new state with the given childMode and the given parent state.
- addTransition(QAbstractTransition)
Adds the given transition. The transition has this state as the source. This state takes ownership of the transition.
- addTransition(QAbstractState) → QAbstractTransition
Adds an unconditional transition from this state to the given target state, and returns then new transition object.
- addTransition(pyqtBoundSignal, QAbstractState) → QSignalTransition
TODO
- assignProperty(QObject, str, Any)
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
- childMode() → ChildMode
Returns the child mode of this state.
See also
- errorState() → QAbstractState
Returns this state鈥檚 error state.
See also
- event(QEvent) → bool
TODO
- initialState() → QAbstractState
Returns this state鈥檚 initial state, or 0 if the state has no initial state.
See also
- onEntry(QEvent)
TODO
- onExit(QEvent)
TODO
- removeTransition(QAbstractTransition)
Removes the given transition from this state. The state releases ownership of the transition.
See also
- setChildMode(ChildMode)
Sets the child mode of this state.
See also
- setErrorState(QAbstractState)
Sets this state鈥檚 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鈥檚 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.
See also
- setInitialState(QAbstractState)
Sets this state鈥檚 initial state to be the given state. state has to be a child of this state.
See also
- transitions() → List[QAbstractTransition]
Returns this state鈥檚 outgoing transitions (i.e. transitions where this state is the sourceState()), or an empty list if this state has no outgoing transitions.
See also
Signals露
- childModeChanged()
TODO
- errorStateChanged()
TODO
- finished()
TODO
- initialStateChanged()
TODO
- propertiesAssigned()
TODO
