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

API reference - Class QSignalMapper

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QSignalMapper

Class hierarchy: QSignalMapper » QObject

Public constructors

new QSignalMappernew(QObject ptr parent = nullptr)Constructor QSignalMapper::QSignalMapper(QObject *parent)

Public methods

[const]QSignalMapper 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 QSignalMapper::destroyed(QObject *)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QSignalMapper::destroyed(QObject *)
voidemit_mapped(int arg1)Emitter for signal void QSignalMapper::mapped(int)
voidemit_mapped_qo(QObject ptr arg1)Emitter for signal void QSignalMapper::mapped(QObject *)
voidemit_mapped_qs(string arg1)Emitter for signal void QSignalMapper::mapped(const QString &)
voidemit_mapped_qw(QWidget ptr arg1)Emitter for signal void QSignalMapper::mapped(QWidget *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QSignalMapper::objectNameChanged(const QString &objectName)
boolevent(QEvent ptr event)Virtual method bool QSignalMapper::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QSignalMapper::eventFilter(QObject *watched, QEvent *event)
voidmapMethod void QSignalMapper::map()
voidmap(QObject ptr sender)Method void QSignalMapper::map(QObject *sender)
[signal]voidmapped(int arg1)Signal declaration for QSignalMapper::mapped(int)
[signal]voidmapped_qo(QObject ptr arg1)Signal declaration for QSignalMapper::mapped(QObject *)
[signal]voidmapped_qs(string arg1)Signal declaration for QSignalMapper::mapped(const QString &)
[signal]voidmapped_qw(QWidget ptr arg1)Signal declaration for QSignalMapper::mapped(QWidget *)
[const]QObject ptrmapping(int id)Method QObject *QSignalMapper::mapping(int id)
[const]QObject ptrmapping(string text)Method QObject *QSignalMapper::mapping(const QString &text)
[const]QObject ptrmapping(QWidget ptr widget)Method QObject *QSignalMapper::mapping(QWidget *widget)
[const]QObject ptrmapping(QObject ptr object)Method QObject *QSignalMapper::mapping(QObject *object)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QSignalMapper::objectNameChanged(const QString &objectName)
voidremoveMappings(QObject ptr sender)Method void QSignalMapper::removeMappings(QObject *sender)
voidsetMapping(QObject ptr sender,
int id)
Method void QSignalMapper::setMapping(QObject *sender, int id)
voidsetMapping(QObject ptr sender,
string text)
Method void QSignalMapper::setMapping(QObject *sender, const QString &text)
voidsetMapping(QObject ptr sender,
QWidget ptr widget)
Method void QSignalMapper::setMapping(QObject *sender, QWidget *widget)
voidsetMapping(QObject ptr sender,
QObject ptr object)
Method void QSignalMapper::setMapping(QObject *sender, QObject *object)

Public static methods and constants

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

Protected methods (static, non-static and constructors)

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

Detailed description

_const_cast

Signature: [const] QSignalMapper 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 QSignalMapper::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

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

Call this method to emit this signal.

emit_mapped

Signature: void emit_mapped (int arg1)

Description: Emitter for signal void QSignalMapper::mapped(int)

Call this method to emit this signal.

emit_mapped_qo

Signature: void emit_mapped_qo (QObject ptr arg1)

Description: Emitter for signal void QSignalMapper::mapped(QObject *)

Call this method to emit this signal.

emit_mapped_qs

Signature: void emit_mapped_qs (string arg1)

Description: Emitter for signal void QSignalMapper::mapped(const QString &)

Call this method to emit this signal.

emit_mapped_qw

Signature: void emit_mapped_qw (QWidget ptr arg1)

Description: Emitter for signal void QSignalMapper::mapped(QWidget *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QSignalMapper::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

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

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

This method can be reimplemented in a derived class.

isSignalConnected

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

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

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

map

(1) Signature: void map

Description: Method void QSignalMapper::map()

(2) Signature: void map (QObject ptr sender)

Description: Method void QSignalMapper::map(QObject *sender)

mapped

Signature: [signal] void mapped (int arg1)

Description: Signal declaration for QSignalMapper::mapped(int)

You can bind a procedure to this signal.

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

mapped_qo

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

Description: Signal declaration for QSignalMapper::mapped(QObject *)

You can bind a procedure to this signal.

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

mapped_qs

Signature: [signal] void mapped_qs (string arg1)

Description: Signal declaration for QSignalMapper::mapped(const QString &)

You can bind a procedure to this signal.

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

mapped_qw

Signature: [signal] void mapped_qw (QWidget ptr arg1)

Description: Signal declaration for QSignalMapper::mapped(QWidget *)

You can bind a procedure to this signal.

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

mapping

(1) Signature: [const] QObject ptr mapping (int id)

Description: Method QObject *QSignalMapper::mapping(int id)

(2) Signature: [const] QObject ptr mapping (string text)

Description: Method QObject *QSignalMapper::mapping(const QString &text)

(3) Signature: [const] QObject ptr mapping (QWidget ptr widget)

Description: Method QObject *QSignalMapper::mapping(QWidget *widget)

(4) Signature: [const] QObject ptr mapping (QObject ptr object)

Description: Method QObject *QSignalMapper::mapping(QObject *object)

new

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

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

This method creates an object of class QSignalMapper.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

receivers

Signature: [const] int receivers (string signal)

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

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

removeMappings

Signature: void removeMappings (QObject ptr sender)

Description: Method void QSignalMapper::removeMappings(QObject *sender)

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QSignalMapper::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QSignalMapper::senderSignalIndex()

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

setMapping

(1) Signature: void setMapping (QObject ptr sender, int id)

Description: Method void QSignalMapper::setMapping(QObject *sender, int id)

(2) Signature: void setMapping (QObject ptr sender, string text)

Description: Method void QSignalMapper::setMapping(QObject *sender, const QString &text)

(3) Signature: void setMapping (QObject ptr sender, QWidget ptr widget)

Description: Method void QSignalMapper::setMapping(QObject *sender, QWidget *widget)

(4) Signature: void setMapping (QObject ptr sender, QObject ptr object)

Description: Method void QSignalMapper::setMapping(QObject *sender, QObject *object)

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

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

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