API reference - Class QState

DontRestoreProperties

Signature: [static,const] QState_RestorePolicy DontRestoreProperties

Description: Enum constant QState::DontRestoreProperties

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

ExclusiveStates

Signature: [static,const] QState_ChildMode ExclusiveStates

Description: Enum constant QState::ExclusiveStates

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

ParallelStates

Signature: [static,const] QState_ChildMode ParallelStates

Description: Enum constant QState::ParallelStates

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

RestoreProperties

Signature: [static,const] QState_RestorePolicy RestoreProperties

Description: Enum constant QState::RestoreProperties

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

_const_cast

Signature: [const] QState 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 QState::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.

addTransition

(1) Signature: void addTransition (QAbstractTransition ptr transition)

Description: Method void QState::addTransition(QAbstractTransition *transition)

(2) Signature: QSignalTransition ptr addTransition (const QObject ptr sender, string signal, QAbstractState ptr target)

Description: Method QSignalTransition *QState::addTransition(const QObject *sender, const char *signal, QAbstractState *target)

(3) Signature: QAbstractTransition ptr addTransition (QAbstractState ptr target)

Description: Method QAbstractTransition *QState::addTransition(QAbstractState *target)

assignProperty

Signature: void assignProperty (QObject ptr object, string name, variant value)

Description: Method void QState::assignProperty(QObject *object, const char *name, const QVariant &value)

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

childMode

Signature: [const] QState_ChildMode childMode

Description: Method QState::ChildMode QState::childMode()

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

childMode=

Signature: void childMode= (const QState_ChildMode mode)

Description: Method void QState::setChildMode(QState::ChildMode mode)

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

childModeChanged

Signature: [signal] void childModeChanged

Description: Signal declaration for QState::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.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QState::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 QState::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 QState::activeChanged(bool active)

Call this method to emit this signal.

emit_childModeChanged

Signature: void emit_childModeChanged

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

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_entered

Signature: void emit_entered

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

Call this method to emit this signal.

emit_errorStateChanged

Signature: void emit_errorStateChanged

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

Call this method to emit this signal.

emit_exited

Signature: void emit_exited

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

Call this method to emit this signal.

emit_finished

Signature: void emit_finished

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

Call this method to emit this signal.

emit_initialStateChanged

Signature: void emit_initialStateChanged

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

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_propertiesAssigned

Signature: void emit_propertiesAssigned

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

Call this method to emit this signal.

entered

Signature: [signal] void entered

Description: Signal declaration for QState::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.

errorState

Signature: [const] QAbstractState ptr errorState

Description: Method QAbstractState *QState::errorState()

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

errorState=

Signature: void errorState= (QAbstractState ptr state)

Description: Method void QState::setErrorState(QAbstractState *state)

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

errorStateChanged

Signature: [signal] void errorStateChanged

Description: Signal declaration for QState::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.

event

Signature: bool event (QEvent ptr e)

Description: Virtual method bool QState::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 QState::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

exited

Signature: [signal] void exited

Description: Signal declaration for QState::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 QState::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.

initialState

Signature: [const] QAbstractState ptr initialState

Description: Method QAbstractState *QState::initialState()

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

initialState=

Signature: void initialState= (QAbstractState ptr state)

Description: Method void QState::setInitialState(QAbstractState *state)

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

initialStateChanged

Signature: [signal] void initialStateChanged

Description: Signal declaration for QState::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.

isSignalConnected

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

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

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

new

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

Description: Constructor QState::QState(QState *parent)

This method creates an object of class QState.

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

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

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

This method creates an object of class QState.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QState::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 QState::onEntry(QEvent *event)

This method can be reimplemented in a derived class.

onExit

Signature: void onExit (QEvent ptr event)

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

This method can be reimplemented in a derived class.

propertiesAssigned

Signature: [signal] void propertiesAssigned

Description: Signal declaration for QState::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 QState::receivers(const char *signal)

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

removeTransition

Signature: void removeTransition (QAbstractTransition ptr transition)

Description: Method void QState::removeTransition(QAbstractTransition *transition)

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QState::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QState::senderSignalIndex()

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

setChildMode

Signature: void setChildMode (const QState_ChildMode mode)

Description: Method void QState::setChildMode(QState::ChildMode mode)

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

setErrorState

Signature: void setErrorState (QAbstractState ptr state)

Description: Method void QState::setErrorState(QAbstractState *state)

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

setInitialState

Signature: void setInitialState (QAbstractState ptr state)

Description: Method void QState::setInitialState(QAbstractState *state)

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QState::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 QState::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 QState::trUtf8(const char *s, const char *c, int n)

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

transitions

Signature: [const] QAbstractTransition ptr[] transitions

Description: Method QList<QAbstractTransition*> QState::transitions()