Skip to content

PythonQt.Qt.QState

QState

PythonQtInstanceWrapper object

Native bases: PythonQtInstanceWrapper

Supplemental documentation: Qt 5 reference:

Detailed Description

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's 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 QStateMachine::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 QState::finished() signal when a final child state (QFinalState) is entered.

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

Source: https://doc.qt.io/archives/qt-5.15/qstate.html

Complete member index

Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.

Member Kind Signature Summary
ChildMode attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
DontRestoreProperties attribute Any (shared captured text)
ExclusiveStates attribute Any (shared captured text)
ParallelStates attribute Any (shared captured text)
RestorePolicy attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
RestoreProperties attribute Any (shared captured text)
__init__ function (self, *args: Any, **kwargs: Any) -> None Native constructor; consult class documentation for supported overloads. (shared captured text)
active attribute Any (shared captured text)
activeChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.Qt.QState.activeChanged; argument details are not documented.
addTransition function (self, sender: Any, signal: Any, target: Any) -> Any X.addTransition(sender, signal, target) -> PythonQt.QtCore.QAbstractTransition (shared captured text)
assignProperty function (self, object: Any, name: str, value: Any) -> None X.assignProperty(object, name, value) (shared captured text)
blockSignals function (self, b: Any) -> bool X.blockSignals(b) -> bool (shared captured text)
childEvent function (self, event: Any) -> Any (shared captured text)
childMode attribute Any This property holds the child mode of this state (shared captured text)
childModeChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.Qt.QState.childModeChanged; argument details are not documented.
children function (self) -> tuple X.children() -> tuple (shared captured text)
className function (self, *args: Any, **kwargs: Any) -> Any Return the classname of the object (shared captured text)
connect function (self, signal: Any, receiver: Any, slot: Any, type: Any) -> bool X.connect(signal, receiver, slot, type) -> bool (shared captured text)
customEvent function (self, event: Any) -> Any (shared captured text)
delete function (self, *args: Any, **kwargs: Any) -> Any Deletes the C++ object (at your own risk, my friend!) (shared captured text)
deleteLater function (self) -> Any (shared captured text)
destroyed function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.Qt.QState.destroyed; argument details are not documented.
disconnect function (self, signal: Any, receiver: Any, slot: Any) -> bool X.disconnect(signal, receiver, slot) -> bool (shared captured text)
dumpObjectInfo function (self) -> Any (shared captured text)
dumpObjectTree function (self) -> Any (shared captured text)
dynamicPropertyNames function (self) -> Any (shared captured text)
entered function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.Qt.QState.entered; argument details are not documented.
errorState attribute QAbstractState This property holds the error state of this state (shared captured text)
errorStateChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.Qt.QState.errorStateChanged; argument details are not documented.
event function (self, e: Any) -> bool X.event(e) -> bool (shared captured text)
eventFilter function (self, watched: Any, event: Any) -> bool X.eventFilter(watched, event) -> bool (shared captured text)
exited function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.Qt.QState.exited; argument details are not documented.
findChild function (self, type: Any, name: Any) -> Any X.findChild(type, name) -> PythonQt.private.QObject (shared captured text)
findChildren function (self, type: Any, name: Any) -> tuple X.findChildren(type, name) -> tuple (shared captured text)
finished function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.Qt.QState.finished; argument details are not documented.
help function (self, *args: Any, **kwargs: Any) -> Any Shows the help of available methods for this class (shared captured text)
inherits function (self, *args: Any, **kwargs: Any) -> Any Returns if the class inherits or is of given type name (shared captured text)
initialState attribute QAbstractState This property holds the initial state of this state (one of its child states) (shared captured text)
initialStateChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.Qt.QState.initialStateChanged; argument details are not documented.
installEventFilter function (self, filterObj: Any) -> Any (shared captured text)
isSignalConnected function (self, signal: Any) -> bool X.isSignalConnected(signal) -> bool (shared captured text)
isWidgetType function (self) -> bool X.isWidgetType() -> bool (shared captured text)
isWindowType function (self) -> bool X.isWindowType() -> bool (shared captured text)
killTimer function (self, id: Any) -> Any (shared captured text)
machine function (self) -> Any X.machine() -> PythonQt.QtCore.QStateMachine (shared captured text)
metaObject function (self) -> Any X.metaObject() -> PythonQt.QtCore.QMetaObject (shared captured text)
moveToThread function (self, thread: Any) -> Any (shared captured text)
objectName attribute Any (shared captured text)
objectNameChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.Qt.QState.objectNameChanged; argument details are not documented.
onEntry function (self, event: Any) -> None Reimplements: [QAbstractState::onEntry](https://doc.qt.io/archives/qt-5.15/qabstractstate.html#onEntry)(QEvent *event). (shared captured text)
onExit function (self, event: Any) -> None Reimplements: [QAbstractState::onExit](https://doc.qt.io/archives/qt-5.15/qabstractstate.html#onExit)(QEvent *event). (shared captured text)
parent function (self) -> Any X.parent() -> PythonQt.private.QObject (shared captured text)
parentState function (self) -> Any X.parentState() -> PythonQt.QtCore.QState (shared captured text)
propertiesAssigned function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.Qt.QState.propertiesAssigned; argument details are not documented.
property function (self, name: Any) -> Any X.property(name) -> object (shared captured text)
removeEventFilter function (self, obj: Any) -> Any (shared captured text)
removeTransition function (self, transition: Any) -> None Removes the given transition from this state. (shared captured text)
sender function (self) -> Any X.sender() -> PythonQt.private.QObject (shared captured text)
senderSignalIndex function (self) -> int X.senderSignalIndex() -> int (shared captured text)
setChildMode function (self, mode: Any) -> None Sets the child mode of this state. (shared captured text)
setErrorState function (self, state: Any) -> None Sets this state's error state to be the given state. (shared captured text)
setInitialState function (self, state: Any) -> None Sets this state's initial state to be the given state. state has to be a child of this state. (shared captured text)
setObjectName function (self, name: Any) -> Any (shared captured text)
setParent function (self, parent: Any) -> Any (shared captured text)
setProperty function (self, name: Any, value: Any) -> bool X.setProperty(name, value) -> bool (shared captured text)
signalsBlocked function (self) -> bool X.signalsBlocked() -> bool (shared captured text)
startTimer function (self, interval: Any, timerType: Any) -> int X.startTimer(interval, timerType) -> int (shared captured text)
thread function (self) -> Any (shared captured text)
timerEvent function (self, event: Any) -> Any (shared captured text)
tr function (self, text: Any, ambig: Any, n: Any) -> str X.tr(text, ambig, n) -> str (shared captured text)
transitions function (self) -> tuple X.transitions() -> tuple (shared captured text)