QState

Inherited by: QStateMachine

Note

This class was introduced in Qt 4.6

Synopsis

Functions

• def addTransition (arg__1, arg__2)
• def addTransition (sender, signal, target)
• def addTransition (target)
• def addTransition (transition)
• def assignProperty (object, name, value)
• def childMode ()
• def errorState ()
• def initialState ()
• def removeTransition (transition)
• def setChildMode (mode)
• def setErrorState (state)
• def setInitialState (state)
• def transitions ()

Signals

• def finished ()
• def propertiesAssigned ()

Detailed Description

The PySide.QtCore.QState class provides a general-purpose state for PySide.QtCore.QStateMachine .

PySide.QtCore.QState objects can have child states, and can have transitions to other states. PySide.QtCore.QState is part of The State Machine Framework .

The PySide.QtCore.QState.addTransition() function adds a transition. The PySide.QtCore.QState.removeTransition() function removes a transition. The PySide.QtCore.QState.transitions() function returns the state’s outgoing transitions.

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

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

States with Child States

The PySide.QtCore.QState.childMode() property determines how child states are treated. For non-parallel state groups, the PySide.QtCore.QState.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 ( PySide.QtCore.QFinalState ) is entered.

The PySide.QtCore.QState.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).

class PySide.QtCore.QState([parent=None])

class PySide.QtCore.QState(childMode[, parent=None])

Parameters:

• parent – PySide.QtCore.QState
• childMode – PySide.QtCore.QState.ChildMode

Constructs a new state with the given parent state.

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

PySide.QtCore.QState.ChildMode

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

Constant	Description
QState.ExclusiveStates	The child states are mutually exclusive and an initial state must be set by calling QState.setInitialState() .
QState.ParallelStates	The child states are parallel. When the parent state is entered, all its child states are entered in parallel.

PySide.QtCore.QState.addTransition(transition)

Parameters:transition – PySide.QtCore.QAbstractTransition

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

PySide.QtCore.QState.addTransition(arg__1, arg__2)

Parameters:

• arg__1 – PyObject
• arg__2 – PySide.QtCore.QAbstractState

Return type:

PySide.QtCore.QSignalTransition

PySide.QtCore.QState.addTransition(sender, signal, target)

Parameters:

• sender – PySide.QtCore.QObject
• signal – str
• target – PySide.QtCore.QAbstractState

Return type:

PySide.QtCore.QSignalTransition

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

PySide.QtCore.QState.addTransition(target)

Parameters:target – PySide.QtCore.QAbstractState Return type:PySide.QtCore.QAbstractTransition

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

PySide.QtCore.QState.assignProperty(object, name, value)

Parameters:

• object – PySide.QtCore.QObject
• name – str
• value – object

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

PySide.QtCore.QState.propertiesAssigned()

PySide.QtCore.QState.childMode()

Return type:PySide.QtCore.QState.ChildMode

This property holds the child mode of this state.

The default value of this property is QState.ExclusiveStates .

PySide.QtCore.QState.errorState()

Return type:PySide.QtCore.QAbstractState

This property holds the error state of this state.

PySide.QtCore.QState.finished()

PySide.QtCore.QState.initialState()

Return type:PySide.QtCore.QAbstractState

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

PySide.QtCore.QState.propertiesAssigned()

PySide.QtCore.QState.removeTransition(transition)

Parameters:transition – PySide.QtCore.QAbstractTransition

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

See also

PySide.QtCore.QState.addTransition()

PySide.QtCore.QState.setChildMode(mode)

Parameters:mode – PySide.QtCore.QState.ChildMode

This property holds the child mode of this state.

The default value of this property is QState.ExclusiveStates .

PySide.QtCore.QState.setErrorState(state)

Parameters:state – PySide.QtCore.QAbstractState

This property holds the error state of this state.

PySide.QtCore.QState.setInitialState(state)

Parameters:state – PySide.QtCore.QAbstractState

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

PySide.QtCore.QState.transitions()

Return type:

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.

See also

PySide.QtCore.QState.addTransition()