API reference - Class QObject

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QObject

Class hierarchy: QObject

Public constructors

new QObjectnew(QObject ptr parent = 0)Constructor QObject::QObject(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.
boolblockSignals(bool b)Method bool QObject::blockSignals(bool b)
[const]QObject ptr[]childrenMethod const QList<QObject*> &QObject::children()
[const]boolconnect(const QObject ptr sender,
string signal,
string member,
const Qt_ConnectionType type = Qt::AutoConnection)
Method bool QObject::connect(const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type)
voiddeleteLaterMethod void QObject::deleteLater()
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QObject::destroyed(QObject *)
booldisconnect(string signal = 0,
const QObject ptr receiver = 0,
string member = 0)
Method bool QObject::disconnect(const char *signal, const QObject *receiver, const char *member)
booldisconnect(const QObject ptr receiver,
string member = 0)
Method bool QObject::disconnect(const QObject *receiver, const char *member)
voiddumpObjectInfoMethod void QObject::dumpObjectInfo()
voiddumpObjectTreeMethod void QObject::dumpObjectTree()
[const]bytes[]dynamicPropertyNamesMethod QList<QByteArray> QObject::dynamicPropertyNames()
voidemit_destroyed(QObject ptr arg1 = 0)Emitter for signal void QObject::destroyed(QObject *)
boolevent(QEvent ptr arg1)Virtual method bool QObject::event(QEvent *)
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QObject::eventFilter(QObject *, QEvent *)
QObject ptrfindChild(string arg1)Specialisation for findChild (uses QObject as T).
[const]boolinherits(string classname)Method bool QObject::inherits(const char *classname)
voidinstallEventFilter(QObject ptr arg1)Method void QObject::installEventFilter(QObject *)
[const]boolisWidgetType?Method bool QObject::isWidgetType()
voidkillTimer(int id)Method void QObject::killTimer(int id)
method_missing(id,
...)
Maps unknown methods to accessors for child objects
voidmoveToThread(QThread ptr thread)Method void QObject::moveToThread(QThread *thread)
[const]stringobjectNameMethod QString QObject::objectName()
voidobjectName=(string name)Method void QObject::setObjectName(const QString &name)
[const]QObject ptrparentMethod QObject *QObject::parent()
voidparent=(QObject ptr arg1)Method void QObject::setParent(QObject *)
[const]variantproperty(string name)Method QVariant QObject::property(const char *name)
voidremoveEventFilter(QObject ptr arg1)Method void QObject::removeEventFilter(QObject *)
voidsetObjectName(string name)Method void QObject::setObjectName(const QString &name)
voidsetParent(QObject ptr arg1)Method void QObject::setParent(QObject *)
boolsetProperty(string name,
variant value)
Method bool QObject::setProperty(const char *name, const QVariant &value)
[const]boolsignalsBlockedMethod bool QObject::signalsBlocked()
intstartTimer(int interval)Method int QObject::startTimer(int interval)
[const]QThread ptrthreadMethod QThread *QObject::thread()

Public static methods and constants

boolconnect(const QObject ptr sender,
string signal,
const QObject ptr receiver,
string member,
const Qt_ConnectionType arg5 = Qt::AutoConnection)
Static method bool QObject::connect(const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType)
booldisconnect(const QObject ptr sender,
string signal,
const QObject ptr receiver,
string member)
Static method bool QObject::disconnect(const QObject *sender, const char *signal, const QObject *receiver, const char *member)
unsigned intregisterUserDataStatic method unsigned int QObject::registerUserData()
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QObject::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QObject::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QObject::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QObject::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr arg1)Virtual method void QObject::childEvent(QChildEvent *)
voidcustomEvent(QEvent ptr arg1)Virtual method void QObject::customEvent(QEvent *)
voiddisconnectNotify(string signal)Virtual method void QObject::disconnectNotify(const char *signal)
[const]intreceivers(string signal)Method int QObject::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QObject::sender()
voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QObject::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]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

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

blockSignals

Signature: bool blockSignals (bool b)

Description: Method bool QObject::blockSignals(bool b)

childEvent

Signature: void childEvent (QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

children

Signature: [const] QObject ptr[] children

Description: Method const QList<QObject*> &QObject::children()

connect

(1) Signature: [const] bool connect (const QObject ptr sender, string signal, string member, const Qt_ConnectionType type = Qt::AutoConnection)

Description: Method bool QObject::connect(const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type)

Python specific notes:
This attribute is available as '_inst_connect' in Python

(2) Signature: [static] bool connect (const QObject ptr sender, string signal, const QObject ptr receiver, string member, const Qt_ConnectionType arg5 = Qt::AutoConnection)

Description: Static method bool QObject::connect(const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType)

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

Python specific notes:
This attribute is available as '_class_connect' in Python

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 arg1)

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

This method can be reimplemented in a derived class.

deleteLater

Signature: void deleteLater

Description: Method void QObject::deleteLater()

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 QObject::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.

disconnect

(1) Signature: bool disconnect (string signal = 0, const QObject ptr receiver = 0, string member = 0)

Description: Method bool QObject::disconnect(const char *signal, const QObject *receiver, const char *member)

Python specific notes:
This attribute is available as '_inst_disconnect' in Python

(2) Signature: bool disconnect (const QObject ptr receiver, string member = 0)

Description: Method bool QObject::disconnect(const QObject *receiver, const char *member)

Python specific notes:
This attribute is available as '_inst_disconnect' in Python

(3) Signature: [static] bool disconnect (const QObject ptr sender, string signal, const QObject ptr receiver, string member)

Description: Static method bool QObject::disconnect(const QObject *sender, const char *signal, const QObject *receiver, const char *member)

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

Python specific notes:
This attribute is available as '_class_disconnect' in Python

disconnectNotify

Signature: void disconnectNotify (string signal)

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

This method can be reimplemented in a derived class.

dumpObjectInfo

Signature: void dumpObjectInfo

Description: Method void QObject::dumpObjectInfo()

dumpObjectTree

Signature: void dumpObjectTree

Description: Method void QObject::dumpObjectTree()

dynamicPropertyNames

Signature: [const] bytes[] dynamicPropertyNames

Description: Method QList<QByteArray> QObject::dynamicPropertyNames()

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = 0)

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

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr arg1, QEvent ptr arg2)

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

This method can be reimplemented in a derived class.

findChild

Signature: QObject ptr findChild (string arg1)

Description: Specialisation for findChild (uses QObject as T).

inherits

Signature: [const] bool inherits (string classname)

Description: Method bool QObject::inherits(const char *classname)

installEventFilter

Signature: void installEventFilter (QObject ptr arg1)

Description: Method void QObject::installEventFilter(QObject *)

isWidgetType?

Signature: [const] bool isWidgetType?

Description: Method bool QObject::isWidgetType()

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.

killTimer

Signature: void killTimer (int id)

Description: Method void QObject::killTimer(int id)

method_missing

Signature: method_missing (id, ...)

Description: Maps unknown methods to accessors for child objects

This method implements Ruby's fallback mechanism and adds some convenience to QObject: through that implementation, each child object can be accessed through it's name. That method will deliver a reference to the child object or nil if there is no child element with that name. For example:

  dialog = MyDialog.new  # has a widget named "button"
  dialog.button.text = "The button text"

If no child object with the given name exists, an exception is thrown. You can use "respond_to?(child_name)" to check whether a child with the given name exists.

moveToThread

Signature: void moveToThread (QThread ptr thread)

Description: Method void QObject::moveToThread(QThread *thread)

new

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

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

This method creates an object of class QObject.

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

objectName

Signature: [const] string objectName

Description: Method QString QObject::objectName()

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

objectName=

Signature: void objectName= (string name)

Description: Method void QObject::setObjectName(const QString &name)

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

parent

Signature: [const] QObject ptr parent

Description: Method QObject *QObject::parent()

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

parent=

Signature: void parent= (QObject ptr arg1)

Description: Method void QObject::setParent(QObject *)

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

property

Signature: [const] variant property (string name)

Description: Method QVariant QObject::property(const char *name)

receivers

Signature: [const] int receivers (string signal)

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

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

registerUserData

Signature: [static] unsigned int registerUserData

Description: Static method unsigned int QObject::registerUserData()

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

removeEventFilter

Signature: void removeEventFilter (QObject ptr arg1)

Description: Method void QObject::removeEventFilter(QObject *)

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QObject::sender()

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

setObjectName

Signature: void setObjectName (string name)

Description: Method void QObject::setObjectName(const QString &name)

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

setParent

Signature: void setParent (QObject ptr arg1)

Description: Method void QObject::setParent(QObject *)

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

setProperty

Signature: bool setProperty (string name, variant value)

Description: Method bool QObject::setProperty(const char *name, const QVariant &value)

signalsBlocked

Signature: [const] bool signalsBlocked

Description: Method bool QObject::signalsBlocked()

startTimer

Signature: int startTimer (int interval)

Description: Method int QObject::startTimer(int interval)

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

thread

Signature: [const] QThread ptr thread

Description: Method QThread *QObject::thread()

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

tr

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

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

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

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

Description: Static method QString QObject::tr(const char *s, const char *c, int n)

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

trUtf8

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

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

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

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

Description: Static method QString QObject::trUtf8(const char *s, const char *c, int n)

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