API reference - Class QHistoryState

DeepHistory

Signature: [static,const] QHistoryState_HistoryType DeepHistory

Description: Enum constant QHistoryState::DeepHistory

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

ShallowHistory

Signature: [static,const] QHistoryState_HistoryType ShallowHistory

Description: Enum constant QHistoryState::ShallowHistory

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

_const_cast

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

defaultState

Signature: [const] QAbstractState ptr defaultState

Description: Method QAbstractState *QHistoryState::defaultState()

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

defaultState=

Signature: void defaultState= (QAbstractState ptr state)

Description: Method void QHistoryState::setDefaultState(QAbstractState *state)

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

defaultStateChanged

Signature: [signal] void defaultStateChanged

Description: Signal declaration for QHistoryState::defaultStateChanged()

You can bind a procedure to this signal.

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

defaultTransition

Signature: [const] QAbstractTransition ptr defaultTransition

Description: Method QAbstractTransition *QHistoryState::defaultTransition()

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

defaultTransition=

Signature: void defaultTransition= (QAbstractTransition ptr transition)

Description: Method void QHistoryState::setDefaultTransition(QAbstractTransition *transition)

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

defaultTransitionChanged

Signature: [signal] void defaultTransitionChanged

Description: Signal declaration for QHistoryState::defaultTransitionChanged()

You can bind a procedure to this signal.

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

destroyed

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

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

Call this method to emit this signal.

emit_defaultStateChanged

Signature: void emit_defaultStateChanged

Description: Emitter for signal void QHistoryState::defaultStateChanged()

Call this method to emit this signal.

emit_defaultTransitionChanged

Signature: void emit_defaultTransitionChanged

Description: Emitter for signal void QHistoryState::defaultTransitionChanged()

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_entered

Signature: void emit_entered

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

Call this method to emit this signal.

emit_exited

Signature: void emit_exited

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

Call this method to emit this signal.

emit_historyTypeChanged

Signature: void emit_historyTypeChanged

Description: Emitter for signal void QHistoryState::historyTypeChanged()

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

entered

Signature: [signal] void entered

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

event

Signature: bool event (QEvent ptr e)

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

This method can be reimplemented in a derived class.

exited

Signature: [signal] void exited

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

historyType

Signature: [const] QHistoryState_HistoryType historyType

Description: Method QHistoryState::HistoryType QHistoryState::historyType()

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

historyType=

Signature: void historyType= (const QHistoryState_HistoryType type)

Description: Method void QHistoryState::setHistoryType(QHistoryState::HistoryType type)

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

historyTypeChanged

Signature: [signal] void historyTypeChanged

Description: Signal declaration for QHistoryState::historyTypeChanged()

You can bind a procedure to this signal.

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

isSignalConnected

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

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

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

new

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

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

This method creates an object of class QHistoryState.

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

(2) Signature: [static] new QHistoryState new (const QHistoryState_HistoryType type, QState ptr parent = nullptr)

Description: Constructor QHistoryState::QHistoryState(QHistoryState::HistoryType type, QState *parent)

This method creates an object of class QHistoryState.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

This method can be reimplemented in a derived class.

onExit

Signature: void onExit (QEvent ptr event)

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

This method can be reimplemented in a derived class.

receivers

Signature: [const] int receivers (string signal)

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

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

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QHistoryState::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QHistoryState::senderSignalIndex()

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

setDefaultState

Signature: void setDefaultState (QAbstractState ptr state)

Description: Method void QHistoryState::setDefaultState(QAbstractState *state)

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

setDefaultTransition

Signature: void setDefaultTransition (QAbstractTransition ptr transition)

Description: Method void QHistoryState::setDefaultTransition(QAbstractTransition *transition)

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

setHistoryType

Signature: void setHistoryType (const QHistoryState_HistoryType type)

Description: Method void QHistoryState::setHistoryType(QHistoryState::HistoryType type)

Python specific notes:
The object exposes a writable attribute 'historyType'. 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 QHistoryState::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 QHistoryState::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 QHistoryState::trUtf8(const char *s, const char *c, int n)

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