API reference - Class QSignalMapper

Notation used in Ruby API documentation

Description: Binding of QSignalMapper

Class hierarchy: QSignalMapper » QObject

Public constructors

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

Public methods

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.
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QSignalMapper::destroyed(QObject *)
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QSignalMapper::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QSignalMapper::eventFilter(QObject *, QEvent *)
voidmapMethod void QSignalMapper::map()
voidmap(QObject ptr sender)Method void QSignalMapper::map(QObject *sender)
[event]voidmapped(int arg1)Signal declaration for QSignalMapper::mapped(int)
[event]voidmapped_qo(QObject ptr arg1)Signal declaration for QSignalMapper::mapped(QObject *)
[event]voidmapped_qs(string arg1)Signal declaration for QSignalMapper::mapped(const QString &)
[event]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)
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 = 0)
Static method QString QSignalMapper::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QSignalMapper::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QSignalMapper::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QSignalMapper::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QSignalMapper::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QSignalMapper::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QSignalMapper::disconnectNotify(const char *signal)
[const]intreceivers(string signal)Method int QSignalMapper::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QSignalMapper::sender()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QSignalMapper::timerEvent(QTimerEvent *)

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]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

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.

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.

[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.

[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.

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.

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.

[virtual] void childEvent(QChildEvent ptr arg1)

Description: Virtual method void QSignalMapper::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QSignalMapper::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

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

This method can be reimplemented in a derived class.

[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

void map

Description: Method void QSignalMapper::map()

void map(QObject ptr sender)

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

[event] void mapped(int arg1)

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

You can bind a procedure to this signal.

[event] void mapped_qo(QObject ptr arg1)

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

You can bind a procedure to this signal.

[event] void mapped_qs(string arg1)

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

You can bind a procedure to this signal.

[event] void mapped_qw(QWidget ptr arg1)

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

You can bind a procedure to this signal.

[const] QObject ptr mapping(int id)

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

[const] QObject ptr mapping(string text)

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

[const] QObject ptr mapping(QWidget ptr widget)

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

[const] QObject ptr mapping(QObject ptr object)

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

[static] new QSignalMapper new(QObject ptr parent = 0)

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

[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.

void removeMappings(QObject ptr sender)

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

[const] QObject ptr sender

Description: Method QObject *QSignalMapper::sender()

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

void setMapping(QObject ptr sender,int id)

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

void setMapping(QObject ptr sender,string text)

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

void setMapping(QObject ptr sender,QWidget ptr widget)

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

void setMapping(QObject ptr sender,QObject ptr object)

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

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

Description: Virtual method void QSignalMapper::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

[static] string tr(string s,string c = 0)

Description: Static method QString QSignalMapper::tr(const char *s, const char *c)

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

[static] string tr(string s,string c,int n)

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.

[static] string trUtf8(string s,string c = 0)

Description: Static method QString QSignalMapper::trUtf8(const char *s, const char *c)

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

[static] string trUtf8(string s,string c,int n)

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.