API reference - Class QObject

Notation used in Ruby API documentation

Description: Binding of QObject

Class hierarchy: QObject

Public constructors

new QObjectnew(QObject ptr parent = 0)Constructor QObject::QObject(QObject *parent)

Public methods

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)
voidcreateEnsures the C++ object is created
voiddeleteLaterMethod void QObject::deleteLater()
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
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]string[]dynamicPropertyNamesMethod QList<QByteArray> QObject::dynamicPropertyNames()
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QObject::event(QEvent *)
[virtual]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]boolisWidgetTypeMethod bool QObject::isWidgetType()
[const]boolisWidgetType?Method bool QObject::isWidgetType()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
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]QVariantproperty(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,
const QVariant 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)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QObject::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QObject::customEvent(QEvent *)
voiddestroyed(QObject ptr arg1 = 0)Method void QObject::destroyed(QObject *)
[virtual]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()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QObject::timerEvent(QTimerEvent *)

Detailed description

bool blockSignals(bool b)

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

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[const] QObject ptr[] children

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

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

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

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.

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void deleteLater

Description: Method void QObject::deleteLater()

void destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

void destroyed(QObject ptr arg1 = 0)

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

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

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

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)

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

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

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

[virtual] void disconnectNotify(string signal)

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

This method can be reimplemented in a derived class.

void dumpObjectInfo

Description: Method void QObject::dumpObjectInfo()

void dumpObjectTree

Description: Method void QObject::dumpObjectTree()

[const] string[] dynamicPropertyNames

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

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

QObject ptr findChild(string arg1)

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

[const] bool inherits(string classname)

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

void installEventFilter(QObject ptr arg1)

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

[const] bool isWidgetType

Description: Method bool QObject::isWidgetType()

[const] bool isWidgetType?

Description: Method bool QObject::isWidgetType()

[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 killTimer(int id)

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

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.

void moveToThread(QThread ptr thread)

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

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

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

This method creates an object of class QObject.

[const] string objectName

Description: Method QString QObject::objectName()

void objectName=(string name)

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

[const] QObject ptr parent

Description: Method QObject *QObject::parent()

void parent=(QObject ptr arg1)

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

[const] QVariant property(string name)

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

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

[static] unsigned int registerUserData

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

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

void removeEventFilter(QObject ptr arg1)

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

[const] QObject ptr sender

Description: Method QObject *QObject::sender()

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

void setObjectName(string name)

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

void setParent(QObject ptr arg1)

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

bool setProperty(string name,const QVariant value)

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

[const] bool signalsBlocked

Description: Method bool QObject::signalsBlocked()

int startTimer(int interval)

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

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[const] QThread ptr thread

Description: Method QThread *QObject::thread()

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

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

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

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