API reference - Class QStateMachine

HighPriority

Signature: [static,const] QStateMachine_EventPriority HighPriority

Description: Enum constant QStateMachine::HighPriority

Python specific notes:
The object exposes a readable attribute 'HighPriority'. This is the getter.

NoCommonAncestorForTransitionError

Signature: [static,const] QStateMachine_Error NoCommonAncestorForTransitionError

Description: Enum constant QStateMachine::NoCommonAncestorForTransitionError

Python specific notes:
The object exposes a readable attribute 'NoCommonAncestorForTransitionError'. This is the getter.

NoDefaultStateInHistoryStateError

Signature: [static,const] QStateMachine_Error NoDefaultStateInHistoryStateError

Description: Enum constant QStateMachine::NoDefaultStateInHistoryStateError

Python specific notes:
The object exposes a readable attribute 'NoDefaultStateInHistoryStateError'. This is the getter.

NoError

Signature: [static,const] QStateMachine_Error NoError

Description: Enum constant QStateMachine::NoError

Python specific notes:
The object exposes a readable attribute 'NoError'. This is the getter.

NoInitialStateError

Signature: [static,const] QStateMachine_Error NoInitialStateError

Description: Enum constant QStateMachine::NoInitialStateError

Python specific notes:
The object exposes a readable attribute 'NoInitialStateError'. This is the getter.

NormalPriority

Signature: [static,const] QStateMachine_EventPriority NormalPriority

Description: Enum constant QStateMachine::NormalPriority

Python specific notes:
The object exposes a readable attribute 'NormalPriority'. This is the getter.

_const_cast

Signature: [const] QStateMachine ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

activeChanged

Signature: [signal] void activeChanged (bool active)

Description: Signal declaration for QStateMachine::activeChanged(bool active)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'activeChanged'. This is the getter.
The object exposes a writable attribute 'activeChanged'. This is the setter.

addDefaultAnimation

Signature: void addDefaultAnimation (QAbstractAnimation ptr animation)

Description: Method void QStateMachine::addDefaultAnimation(QAbstractAnimation *animation)

addState

Signature: void addState (QAbstractState ptr state)

Description: Method void QStateMachine::addState(QAbstractState *state)

animated

Signature: [const] bool animated

Description: Method bool QStateMachine::isAnimated()

Python specific notes:
The object exposes a readable attribute 'animated'. This is the getter.

animated=

Signature: void animated= (bool enabled)

Description: Method void QStateMachine::setAnimated(bool enabled)

Python specific notes:
The object exposes a writable attribute 'animated'. This is the setter.

beginMicrostep

Signature: void beginMicrostep (QEvent ptr event)

Description: Virtual method void QStateMachine::beginMicrostep(QEvent *event)

This method can be reimplemented in a derived class.

beginSelectTransitions

Signature: void beginSelectTransitions (QEvent ptr event)

Description: Virtual method void QStateMachine::beginSelectTransitions(QEvent *event)

This method can be reimplemented in a derived class.

cancelDelayedEvent

Signature: bool cancelDelayedEvent (int id)

Description: Method bool QStateMachine::cancelDelayedEvent(int id)

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QStateMachine::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

childModeChanged

Signature: [signal] void childModeChanged

Description: Signal declaration for QStateMachine::childModeChanged()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'childModeChanged'. This is the getter.
The object exposes a writable attribute 'childModeChanged'. This is the setter.

clearError

Signature: void clearError

Description: Method void QStateMachine::clearError()

configuration

Signature: [const] QAbstractState ptr[] configuration

Description: Method QSet<QAbstractState*> QStateMachine::configuration()

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QStateMachine::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

defaultAnimations

Signature: [const] QAbstractAnimation ptr[] defaultAnimations

Description: Method QList<QAbstractAnimation *> QStateMachine::defaultAnimations()

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QStateMachine::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QStateMachine::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_activeChanged

Signature: void emit_activeChanged (bool active)

Description: Emitter for signal void QStateMachine::activeChanged(bool active)

Call this method to emit this signal.

emit_childModeChanged

Signature: void emit_childModeChanged

Description: Emitter for signal void QStateMachine::childModeChanged()

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QStateMachine::destroyed(QObject *)

Call this method to emit this signal.

emit_entered

Signature: void emit_entered

Description: Emitter for signal void QStateMachine::entered()

Call this method to emit this signal.

emit_errorStateChanged

Signature: void emit_errorStateChanged

Description: Emitter for signal void QStateMachine::errorStateChanged()

Call this method to emit this signal.

emit_exited

Signature: void emit_exited

Description: Emitter for signal void QStateMachine::exited()

Call this method to emit this signal.

emit_finished

Signature: void emit_finished

Description: Emitter for signal void QStateMachine::finished()

Call this method to emit this signal.

emit_initialStateChanged

Signature: void emit_initialStateChanged

Description: Emitter for signal void QStateMachine::initialStateChanged()

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QStateMachine::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_propertiesAssigned

Signature: void emit_propertiesAssigned

Description: Emitter for signal void QStateMachine::propertiesAssigned()

Call this method to emit this signal.

emit_runningChanged

Signature: void emit_runningChanged (bool running)

Description: Emitter for signal void QStateMachine::runningChanged(bool running)

Call this method to emit this signal.

emit_started

Signature: void emit_started

Description: Emitter for signal void QStateMachine::started()

Call this method to emit this signal.

emit_stopped

Signature: void emit_stopped

Description: Emitter for signal void QStateMachine::stopped()

Call this method to emit this signal.

endMicrostep

Signature: void endMicrostep (QEvent ptr event)

Description: Virtual method void QStateMachine::endMicrostep(QEvent *event)

This method can be reimplemented in a derived class.

endSelectTransitions

Signature: void endSelectTransitions (QEvent ptr event)

Description: Virtual method void QStateMachine::endSelectTransitions(QEvent *event)

This method can be reimplemented in a derived class.

entered

Signature: [signal] void entered

Description: Signal declaration for QStateMachine::entered()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'entered'. This is the getter.
The object exposes a writable attribute 'entered'. This is the setter.

error

Signature: [const] QStateMachine_Error error

Description: Method QStateMachine::Error QStateMachine::error()

errorStateChanged

Signature: [signal] void errorStateChanged

Description: Signal declaration for QStateMachine::errorStateChanged()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'errorStateChanged'. This is the getter.
The object exposes a writable attribute 'errorStateChanged'. This is the setter.

errorString

Signature: [const] string errorString

Description: Method QString QStateMachine::errorString()

Python specific notes:
The object exposes a readable attribute 'errorString'. This is the getter.

event

Signature: bool event (QEvent ptr e)

Description: Virtual method bool QStateMachine::event(QEvent *e)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QStateMachine::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

exited

Signature: [signal] void exited

Description: Signal declaration for QStateMachine::exited()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'exited'. This is the getter.
The object exposes a writable attribute 'exited'. This is the setter.

finished

Signature: [signal] void finished

Description: Signal declaration for QStateMachine::finished()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'finished'. This is the getter.
The object exposes a writable attribute 'finished'. This is the setter.

globalRestorePolicy

Signature: [const] QState_RestorePolicy globalRestorePolicy

Description: Method QState::RestorePolicy QStateMachine::globalRestorePolicy()

Python specific notes:
The object exposes a readable attribute 'globalRestorePolicy'. This is the getter.

globalRestorePolicy=

Signature: void globalRestorePolicy= (const QState_RestorePolicy restorePolicy)

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

Python specific notes:
The object exposes a writable attribute 'globalRestorePolicy'. This is the setter.

initialStateChanged

Signature: [signal] void initialStateChanged

Description: Signal declaration for QStateMachine::initialStateChanged()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'initialStateChanged'. This is the getter.
The object exposes a writable attribute 'initialStateChanged'. This is the setter.

isAnimated?

Signature: [const] bool isAnimated?

Description: Method bool QStateMachine::isAnimated()

Python specific notes:
The object exposes a readable attribute 'animated'. This is the getter.

isRunning?

Signature: [const] bool isRunning?

Description: Method bool QStateMachine::isRunning()

Python specific notes:
The object exposes a readable attribute 'running'. This is the getter.

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QStateMachine::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

new

(1) Signature: [static] new QStateMachine new (QObject ptr parent = nullptr)

Description: Constructor QStateMachine::QStateMachine(QObject *parent)

This method creates an object of class QStateMachine.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QStateMachine new (const QState_ChildMode childMode, QObject ptr parent = nullptr)

Description: Constructor QStateMachine::QStateMachine(QState::ChildMode childMode, QObject *parent)

This method creates an object of class QStateMachine.

Python specific notes:
This method is the default initializer of the object.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QStateMachine::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

onEntry

Signature: void onEntry (QEvent ptr event)

Description: Virtual method void QStateMachine::onEntry(QEvent *event)

This method can be reimplemented in a derived class.

onExit

Signature: void onExit (QEvent ptr event)

Description: Virtual method void QStateMachine::onExit(QEvent *event)

This method can be reimplemented in a derived class.

postDelayedEvent

Signature: int postDelayedEvent (QEvent ptr event, int delay)

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

postEvent

Signature: void postEvent (QEvent ptr event, const QStateMachine_EventPriority priority = QStateMachine::NormalPriority)

Description: Method void QStateMachine::postEvent(QEvent *event, QStateMachine::EventPriority priority)

propertiesAssigned

Signature: [signal] void propertiesAssigned

Description: Signal declaration for QStateMachine::propertiesAssigned()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'propertiesAssigned'. This is the getter.
The object exposes a writable attribute 'propertiesAssigned'. This is the setter.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QStateMachine::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

removeDefaultAnimation

Signature: void removeDefaultAnimation (QAbstractAnimation ptr animation)

Description: Method void QStateMachine::removeDefaultAnimation(QAbstractAnimation *animation)

removeState

Signature: void removeState (QAbstractState ptr state)

Description: Method void QStateMachine::removeState(QAbstractState *state)

running

Signature: [const] bool running

Description: Method bool QStateMachine::isRunning()

Python specific notes:
The object exposes a readable attribute 'running'. This is the getter.

running=

Signature: void running= (bool running)

Description: Method void QStateMachine::setRunning(bool running)

Python specific notes:
The object exposes a writable attribute 'running'. This is the setter.

runningChanged

Signature: [signal] void runningChanged (bool running)

Description: Signal declaration for QStateMachine::runningChanged(bool running)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'runningChanged'. This is the getter.
The object exposes a writable attribute 'runningChanged'. This is the setter.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QStateMachine::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QStateMachine::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setAnimated

Signature: void setAnimated (bool enabled)

Description: Method void QStateMachine::setAnimated(bool enabled)

Python specific notes:
The object exposes a writable attribute 'animated'. This is the setter.

setGlobalRestorePolicy

Signature: void setGlobalRestorePolicy (const QState_RestorePolicy restorePolicy)

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

Python specific notes:
The object exposes a writable attribute 'globalRestorePolicy'. This is the setter.

setRunning

Signature: void setRunning (bool running)

Description: Method void QStateMachine::setRunning(bool running)

Python specific notes:
The object exposes a writable attribute 'running'. This is the setter.

start

Signature: void start

Description: Method void QStateMachine::start()

started

Signature: [signal] void started

Description: Signal declaration for QStateMachine::started()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'started'. This is the getter.
The object exposes a writable attribute 'started'. This is the setter.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

stop

Signature: void stop

Description: Method void QStateMachine::stop()

stopped

Signature: [signal] void stopped

Description: Signal declaration for QStateMachine::stopped()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'stopped'. This is the getter.
The object exposes a writable attribute 'stopped'. This is the setter.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QStateMachine::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QStateMachine::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QStateMachine::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.