KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QAbstractTransition

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QAbstractTransition

Class hierarchy: QAbstractTransition » QObject

Sub-classes: TransitionType, QFlags_TransitionType

Public constructors

new QAbstractTransitionnew(QState ptr sourceState = nullptr)Constructor QAbstractTransition::QAbstractTransition(QState *sourceState)

Public methods

[const]QAbstractTransition ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidaddAnimation(QAbstractAnimation ptr animation)Method void QAbstractTransition::addAnimation(QAbstractAnimation *animation)
[const]QAbstractAnimation ptr[]animationsMethod QList<QAbstractAnimation*> QAbstractTransition::animations()
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QAbstractTransition::destroyed(QObject *)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QAbstractTransition::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QAbstractTransition::objectNameChanged(const QString &objectName)
voidemit_targetStateChangedEmitter for signal void QAbstractTransition::targetStateChanged()
voidemit_targetStatesChangedEmitter for signal void QAbstractTransition::targetStatesChanged()
voidemit_triggeredEmitter for signal void QAbstractTransition::triggered()
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QAbstractTransition::eventFilter(QObject *watched, QEvent *event)
[const]QStateMachine ptrmachineMethod QStateMachine *QAbstractTransition::machine()
[signal]voidobjectNameChanged(string objectName)Signal declaration for QAbstractTransition::objectNameChanged(const QString &objectName)
voidremoveAnimation(QAbstractAnimation ptr animation)Method void QAbstractTransition::removeAnimation(QAbstractAnimation *animation)
voidsetTargetState(QAbstractState ptr target)Method void QAbstractTransition::setTargetState(QAbstractState *target)
voidsetTargetStates(QAbstractState ptr[] targets)Method void QAbstractTransition::setTargetStates(const QList<QAbstractState*> &targets)
voidsetTransitionType(const QAbstractTransition_TransitionType type)Method void QAbstractTransition::setTransitionType(QAbstractTransition::TransitionType type)
[const]QState ptrsourceStateMethod QState *QAbstractTransition::sourceState()
[const]QAbstractState ptrtargetStateMethod QAbstractState *QAbstractTransition::targetState()
voidtargetState=(QAbstractState ptr target)Method void QAbstractTransition::setTargetState(QAbstractState *target)
[signal]voidtargetStateChangedSignal declaration for QAbstractTransition::targetStateChanged()
[const]QAbstractState ptr[]targetStatesMethod QList<QAbstractState*> QAbstractTransition::targetStates()
voidtargetStates=(QAbstractState ptr[] targets)Method void QAbstractTransition::setTargetStates(const QList<QAbstractState*> &targets)
[signal]voidtargetStatesChangedSignal declaration for QAbstractTransition::targetStatesChanged()
[const]QAbstractTransition_TransitionTypetransitionTypeMethod QAbstractTransition::TransitionType QAbstractTransition::transitionType()
voidtransitionType=(const QAbstractTransition_TransitionType type)Method void QAbstractTransition::setTransitionType(QAbstractTransition::TransitionType type)
[signal]voidtriggeredSignal declaration for QAbstractTransition::triggered()

Public static methods and constants

[static,const]QAbstractTransition_TransitionTypeExternalTransitionEnum constant QAbstractTransition::ExternalTransition
[static,const]QAbstractTransition_TransitionTypeInternalTransitionEnum constant QAbstractTransition::InternalTransition
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QAbstractTransition::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QAbstractTransition::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr event)Virtual method void QAbstractTransition::childEvent(QChildEvent *event)
voidcustomEvent(QEvent ptr event)Virtual method void QAbstractTransition::customEvent(QEvent *event)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QAbstractTransition::disconnectNotify(const QMetaMethod &signal)
boolevent(QEvent ptr e)Virtual method bool QAbstractTransition::event(QEvent *e)
booleventTest(QEvent ptr event)Virtual method bool QAbstractTransition::eventTest(QEvent *event)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QAbstractTransition::isSignalConnected(const QMetaMethod &signal)
voidonTransition(QEvent ptr event)Virtual method void QAbstractTransition::onTransition(QEvent *event)
[const]intreceivers(string signal)Method int QAbstractTransition::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QAbstractTransition::sender()
[const]intsenderSignalIndexMethod int QAbstractTransition::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr event)Virtual method void QAbstractTransition::timerEvent(QTimerEvent *event)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

ExternalTransition

Signature: [static,const] QAbstractTransition_TransitionType ExternalTransition

Description: Enum constant QAbstractTransition::ExternalTransition

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

InternalTransition

Signature: [static,const] QAbstractTransition_TransitionType InternalTransition

Description: Enum constant QAbstractTransition::InternalTransition

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

_const_cast

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

addAnimation

Signature: void addAnimation (QAbstractAnimation ptr animation)

Description: Method void QAbstractTransition::addAnimation(QAbstractAnimation *animation)

animations

Signature: [const] QAbstractAnimation ptr[] animations

Description: Method QList<QAbstractAnimation*> QAbstractTransition::animations()

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QAbstractTransition::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 QAbstractTransition::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_targetStateChanged

Signature: void emit_targetStateChanged

Description: Emitter for signal void QAbstractTransition::targetStateChanged()

Call this method to emit this signal.

emit_targetStatesChanged

Signature: void emit_targetStatesChanged

Description: Emitter for signal void QAbstractTransition::targetStatesChanged()

Call this method to emit this signal.

emit_triggered

Signature: void emit_triggered

Description: Emitter for signal void QAbstractTransition::triggered()

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr e)

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

This method can be reimplemented in a derived class.

eventTest

Signature: bool eventTest (QEvent ptr event)

Description: Virtual method bool QAbstractTransition::eventTest(QEvent *event)

This method can be reimplemented in a derived class.

isSignalConnected

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

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

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

is_const_object?

Signature: [const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

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

machine

Signature: [const] QStateMachine ptr machine

Description: Method QStateMachine *QAbstractTransition::machine()

new

Signature: [static] new QAbstractTransition new (QState ptr sourceState = nullptr)

Description: Constructor QAbstractTransition::QAbstractTransition(QState *sourceState)

This method creates an object of class QAbstractTransition.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

onTransition

Signature: void onTransition (QEvent ptr event)

Description: Virtual method void QAbstractTransition::onTransition(QEvent *event)

This method can be reimplemented in a derived class.

receivers

Signature: [const] int receivers (string signal)

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

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

removeAnimation

Signature: void removeAnimation (QAbstractAnimation ptr animation)

Description: Method void QAbstractTransition::removeAnimation(QAbstractAnimation *animation)

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QAbstractTransition::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QAbstractTransition::senderSignalIndex()

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

setTargetState

Signature: void setTargetState (QAbstractState ptr target)

Description: Method void QAbstractTransition::setTargetState(QAbstractState *target)

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

setTargetStates

Signature: void setTargetStates (QAbstractState ptr[] targets)

Description: Method void QAbstractTransition::setTargetStates(const QList<QAbstractState*> &targets)

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

setTransitionType

Signature: void setTransitionType (const QAbstractTransition_TransitionType type)

Description: Method void QAbstractTransition::setTransitionType(QAbstractTransition::TransitionType type)

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

sourceState

Signature: [const] QState ptr sourceState

Description: Method QState *QAbstractTransition::sourceState()

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

targetState

Signature: [const] QAbstractState ptr targetState

Description: Method QAbstractState *QAbstractTransition::targetState()

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

targetState=

Signature: void targetState= (QAbstractState ptr target)

Description: Method void QAbstractTransition::setTargetState(QAbstractState *target)

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

targetStateChanged

Signature: [signal] void targetStateChanged

Description: Signal declaration for QAbstractTransition::targetStateChanged()

You can bind a procedure to this signal.

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

targetStates

Signature: [const] QAbstractState ptr[] targetStates

Description: Method QList<QAbstractState*> QAbstractTransition::targetStates()

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

targetStates=

Signature: void targetStates= (QAbstractState ptr[] targets)

Description: Method void QAbstractTransition::setTargetStates(const QList<QAbstractState*> &targets)

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

targetStatesChanged

Signature: [signal] void targetStatesChanged

Description: Signal declaration for QAbstractTransition::targetStatesChanged()

You can bind a procedure to this signal.

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

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

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

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

transitionType

Signature: [const] QAbstractTransition_TransitionType transitionType

Description: Method QAbstractTransition::TransitionType QAbstractTransition::transitionType()

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

transitionType=

Signature: void transitionType= (const QAbstractTransition_TransitionType type)

Description: Method void QAbstractTransition::setTransitionType(QAbstractTransition::TransitionType type)

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

triggered

Signature: [signal] void triggered

Description: Signal declaration for QAbstractTransition::triggered()

You can bind a procedure to this signal.

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