KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QSignalTransition

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QSignalTransition

Class hierarchy: QSignalTransition » QAbstractTransition » QObject

Public constructors

new QSignalTransitionnew(QState ptr sourceState = nullptr)Constructor QSignalTransition::QSignalTransition(QState *sourceState)
new QSignalTransitionnew(const QObject ptr sender,
string signal,
QState ptr sourceState = nullptr)
Constructor QSignalTransition::QSignalTransition(const QObject *sender, const char *signal, QState *sourceState)

Public methods

[const]QSignalTransition 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.
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QSignalTransition::destroyed(QObject *)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QSignalTransition::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QSignalTransition::objectNameChanged(const QString &objectName)
voidemit_senderObjectChangedEmitter for signal void QSignalTransition::senderObjectChanged()
voidemit_signalChangedEmitter for signal void QSignalTransition::signalChanged()
voidemit_targetStateChangedEmitter for signal void QSignalTransition::targetStateChanged()
voidemit_targetStatesChangedEmitter for signal void QSignalTransition::targetStatesChanged()
voidemit_triggeredEmitter for signal void QSignalTransition::triggered()
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QSignalTransition::eventFilter(QObject *watched, QEvent *event)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QSignalTransition::objectNameChanged(const QString &objectName)
[const]QObject ptrsenderObjectMethod QObject *QSignalTransition::senderObject()
voidsenderObject=(const QObject ptr sender)Method void QSignalTransition::setSenderObject(const QObject *sender)
[signal]voidsenderObjectChangedSignal declaration for QSignalTransition::senderObjectChanged()
voidsetSenderObject(const QObject ptr sender)Method void QSignalTransition::setSenderObject(const QObject *sender)
voidsetSignal(bytes signal)Method void QSignalTransition::setSignal(const QByteArray &signal)
[const]bytessignalMethod QByteArray QSignalTransition::signal()
voidsignal=(bytes signal)Method void QSignalTransition::setSignal(const QByteArray &signal)
[signal]voidsignalChangedSignal declaration for QSignalTransition::signalChanged()
[signal]voidtargetStateChangedSignal declaration for QSignalTransition::targetStateChanged()
[signal]voidtargetStatesChangedSignal declaration for QSignalTransition::targetStatesChanged()
[signal]voidtriggeredSignal declaration for QSignalTransition::triggered()

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QSignalTransition::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QSignalTransition::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

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

Detailed description

_const_cast

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QSignalTransition::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 QSignalTransition::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 QSignalTransition::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_senderObjectChanged

Signature: void emit_senderObjectChanged

Description: Emitter for signal void QSignalTransition::senderObjectChanged()

Call this method to emit this signal.

emit_signalChanged

Signature: void emit_signalChanged

Description: Emitter for signal void QSignalTransition::signalChanged()

Call this method to emit this signal.

emit_targetStateChanged

Signature: void emit_targetStateChanged

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

Call this method to emit this signal.

emit_targetStatesChanged

Signature: void emit_targetStatesChanged

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

Call this method to emit this signal.

emit_triggered

Signature: void emit_triggered

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

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr e)

Description: Virtual method bool QSignalTransition::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 QSignalTransition::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 QSignalTransition::eventTest(QEvent *event)

This method can be reimplemented in a derived class.

isSignalConnected

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

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

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

new

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

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

This method creates an object of class QSignalTransition.

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

(2) Signature: [static] new QSignalTransition new (const QObject ptr sender, string signal, QState ptr sourceState = nullptr)

Description: Constructor QSignalTransition::QSignalTransition(const QObject *sender, const char *signal, QState *sourceState)

This method creates an object of class QSignalTransition.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

This method can be reimplemented in a derived class.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QSignalTransition::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 *QSignalTransition::sender()

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

senderObject

Signature: [const] QObject ptr senderObject

Description: Method QObject *QSignalTransition::senderObject()

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

senderObject=

Signature: void senderObject= (const QObject ptr sender)

Description: Method void QSignalTransition::setSenderObject(const QObject *sender)

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

senderObjectChanged

Signature: [signal] void senderObjectChanged

Description: Signal declaration for QSignalTransition::senderObjectChanged()

You can bind a procedure to this signal.

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QSignalTransition::senderSignalIndex()

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

setSenderObject

Signature: void setSenderObject (const QObject ptr sender)

Description: Method void QSignalTransition::setSenderObject(const QObject *sender)

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

setSignal

Signature: void setSignal (bytes signal)

Description: Method void QSignalTransition::setSignal(const QByteArray &signal)

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

signal

Signature: [const] bytes signal

Description: Method QByteArray QSignalTransition::signal()

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

signal=

Signature: void signal= (bytes signal)

Description: Method void QSignalTransition::setSignal(const QByteArray &signal)

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

signalChanged

Signature: [signal] void signalChanged

Description: Signal declaration for QSignalTransition::signalChanged()

You can bind a procedure to this signal.

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

targetStateChanged

Signature: [signal] void targetStateChanged

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

targetStatesChanged

Signature: [signal] void targetStatesChanged

Description: Signal declaration for QSignalTransition::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 QSignalTransition::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 QSignalTransition::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 QSignalTransition::trUtf8(const char *s, const char *c, int n)

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

triggered

Signature: [signal] void triggered

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