KLayout Manual: Main Index » Class Index » API reference - Class QObject

API reference - Class QObject

Notation used in Ruby API documentation

Description: Binding of QObject

Class hierarchy: QObject

• Public constructors
• Public methods
• Public static methods and constants
• Protected methods (static, non-static and constructors)
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

Deprecated methods (protected, public, static, non-static and constructors)

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.

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)

Python specific notes:

This method is available as method '_inst_connect' in Python

[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 method is available as method '_class_connect' in Python

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 QObject::customEvent(QEvent *)

This method can be reimplemented in a derived class.

void deleteLater

Description: Method void QObject::deleteLater()

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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

Use of this method is deprecated. Use _destroyed? instead

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 method is available as method '_inst_disconnect' in Python

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

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

Python specific notes:

This method is available as method '_inst_disconnect' in Python

[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 method is available as method '_class_disconnect' in Python

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

Python specific notes:

This method is the default initializer of the object

[const] string objectName

Description: Method QString QObject::objectName()

Python specific notes:

The object exposes a readable attribute 'objectName'. This is the getter.

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.

[const] QObject ptr parent

Description: Method QObject *QObject::parent()

Python specific notes:

The object exposes a readable attribute 'parent'. This is the getter.

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.

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

Python specific notes:

The object exposes a writable attribute 'objectName'. This is the setter.

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.

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.