Skip to content

PythonQt.QtCore.QStateMachine · declarations 002

Back to PythonQt.QtCore.QStateMachine

objectNameChanged

objectNameChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QStateMachine.objectNameChanged; argument details are not documented.

onEntry

onEntry(event: Any) -> None

X.onEntry(event)

Supplemental documentation: Qt 5 reference:

[override virtual protected] void QStateMachine::onEntry(QEvent *event)

Reimplements: QState::onEntry(QEvent *event).

This function will call start() to start the state machine.

Upstream PySide2 reference signatures (binding differences may apply):

onEntry(self, event: PySide2.QtCore.QEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qstatemachine.html#onEntry

onExit

onExit(event: Any) -> None

X.onExit(event)

Supplemental documentation: Qt 5 reference:

[override virtual protected] void QStateMachine::onExit(QEvent *event)

Reimplements: QState::onExit(QEvent *event).

This function will call stop() to stop the state machine and subsequently emit the stopped() signal.

Upstream PySide2 reference signatures (binding differences may apply):

onExit(self, event: PySide2.QtCore.QEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qstatemachine.html#onExit

postDelayedEvent

postDelayedEvent(event: Any, delay: int) -> int

X.postDelayedEvent(event, delay) -> int

Supplemental documentation: Qt 5 reference:

int QStateMachine::postDelayedEvent(QEvent *event, int delay)

This is an overloaded function.

Posts the given event for processing by this state machine, with the given delay in milliseconds. Returns an identifier associated with the delayed event, or -1 if the event could not be posted.

This function returns immediately. When the delay has expired, the event will be added to the state machine's event queue for processing. The state machine takes ownership of the event and deletes it once it has been processed.

You can only post events when the state machine is running.

Note: This function is thread-safe.

This function was introduced in Qt 5.15.

See also cancelDelayedEvent() and postEvent().

Upstream PySide2 reference signatures (binding differences may apply):

postDelayedEvent(self, event: PySide2.QtCore.QEvent, delay: int) -> int

Source: https://doc.qt.io/archives/qt-5.15/qstatemachine.html#postDelayedEvent

postEvent

postEvent(event: Any, priority: Any) -> None

X.postEvent(event, priority)

Supplemental documentation: Qt 5 reference:

void QStateMachine::postEvent(QEvent *event, QStateMachine::EventPriority priority \= NormalPriority)

Posts the given event of the given priority for processing by this state machine.

This function returns immediately. The event is added to the state machine's event queue. Events are processed in the order posted. The state machine takes ownership of the event and deletes it once it has been processed.

You can only post events when the state machine is running or when it is starting up.

Note: This function is thread-safe.

See also postDelayedEvent().

Upstream PySide2 reference signatures (binding differences may apply):

postEvent(self, event: PySide2.QtCore.QEvent, priority: PySide2.QtCore.QStateMachine.EventPriority=...) -> None

Source: https://doc.qt.io/archives/qt-5.15/qstatemachine.html#postEvent

propertiesAssigned

propertiesAssigned(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QStateMachine.propertiesAssigned; argument details are not documented.

removeDefaultAnimation

removeDefaultAnimation(animation: Any) -> None

X.removeDefaultAnimation(animation)

Supplemental documentation: Qt 5 reference:

void QStateMachine::removeDefaultAnimation(QAbstractAnimation *animation)

Removes animation from the list of default animations.

Upstream PySide2 reference signatures (binding differences may apply):

removeDefaultAnimation(self, animation: PySide2.QtCore.QAbstractAnimation) -> None

Source: https://doc.qt.io/archives/qt-5.15/qstatemachine.html#removeDefaultAnimation

removeState

removeState(state: Any) -> None

X.removeState(state)

Supplemental documentation: Qt 5 reference:

void QStateMachine::removeState(QAbstractState *state)

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

See also addState().

Upstream PySide2 reference signatures (binding differences may apply):

removeState(self, state: PySide2.QtCore.QAbstractState) -> None

Source: https://doc.qt.io/archives/qt-5.15/qstatemachine.html#removeState

removeTransition

removeTransition(transition: Any) -> Any

X.removeTransition(transition)

running instance-attribute

running: Any

Qt 5 reference:

running : bool

This property holds the running state of this state machine

This property was introduced in Qt 5.4.

Access functions:

bool isRunning() const
void setRunning(bool running)

Notifier signal:

void runningChanged(bool running)

See also start(), stop(), started(), stopped(), and runningChanged().

Source: https://doc.qt.io/archives/qt-5.15/qstatemachine.html#running

runningChanged

runningChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QStateMachine.runningChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QStateMachine::runningChanged(bool running)

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

Note: Notifier signal for property running.

This function was introduced in Qt 5.4.

See also QStateMachine::running.

Source: https://doc.qt.io/archives/qt-5.15/qstatemachine.html#runningChanged

setAnimated

setAnimated(enabled: bool) -> None

X.setAnimated(enabled)

Supplemental documentation: Qt 5 reference:

void QStateMachine::setAnimated(bool enabled)

Sets whether animations are enabled for this state machine.

Note: Setter function for property animated.

See also isAnimated().

Upstream PySide2 reference signatures (binding differences may apply):

setAnimated(self, enabled: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qstatemachine.html#setAnimated

setChildMode

setChildMode(mode: Any) -> Any

X.setChildMode(mode)

setErrorState

setErrorState(state: Any) -> Any

X.setErrorState(state)

setGlobalRestorePolicy

setGlobalRestorePolicy(restorePolicy: Any) -> None

X.setGlobalRestorePolicy(restorePolicy)

Supplemental documentation: Qt 5 reference:

void QStateMachine::setGlobalRestorePolicy(QState::RestorePolicy restorePolicy)

Sets the restore policy of the state machine to restorePolicy. The default restore policy is QState::DontRestoreProperties.

Note: Setter function for property globalRestorePolicy.

See also globalRestorePolicy().

Upstream PySide2 reference signatures (binding differences may apply):

setGlobalRestorePolicy(self, restorePolicy: PySide2.QtCore.QState.RestorePolicy) -> None

Source: https://doc.qt.io/archives/qt-5.15/qstatemachine.html#setGlobalRestorePolicy

setInitialState

setInitialState(state: Any) -> Any

X.setInitialState(state)

setRunning

setRunning(running: bool) -> None

X.setRunning(running)

Upstream PySide2 reference signatures (binding differences may apply):

setRunning(self, running: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qstatemachine.html#setRunning

start

start() -> None

X.start()

Supplemental documentation: Qt 5 reference:

[slot] void QStateMachine::start()

Starts this state machine. The machine will reset its configuration and transition to the initial state. When a final top-level state (QFinalState) is entered, the machine will emit the finished() signal.

Note: A state machine will not run without a running event loop, such as the main application event loop started with QCoreApplication::exec() or QApplication::exec().

See also started(), finished(), stop(), initialState(), and setRunning().

Upstream PySide2 reference signatures (binding differences may apply):

start(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qstatemachine.html#start

started

started(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QStateMachine.started; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QStateMachine::started()

This signal is emitted when the state machine has entered its initial state (QStateMachine::initialState).

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

See also QStateMachine::finished() and QStateMachine::start().

Source: https://doc.qt.io/archives/qt-5.15/qstatemachine.html#started

stop

stop() -> None

X.stop()

Supplemental documentation: Qt 5 reference:

[slot] void QStateMachine::stop()

Stops this state machine. The state machine will stop processing events and then emit the stopped() signal.

See also stopped(), start(), and setRunning().

Upstream PySide2 reference signatures (binding differences may apply):

stop(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qstatemachine.html#stop

stopped

stopped(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QStateMachine.stopped; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QStateMachine::stopped()

This signal is emitted when the state machine has stopped.

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

See also QStateMachine::stop() and QStateMachine::finished().

Source: https://doc.qt.io/archives/qt-5.15/qstatemachine.html#stopped

transitions

transitions() -> tuple

X.transitions() -> tuple