API reference - Class QMetaObject

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QMetaObject

Public constructors

new QMetaObjectnewConstructor QMetaObject::QMetaObject()

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.
voidassign(const QMetaObject other)Assigns another object to self
[const]QMetaClassInfoclassInfo(int index)Method QMetaClassInfo QMetaObject::classInfo(int index)
[const]intclassInfoCountMethod int QMetaObject::classInfoCount()
[const]intclassInfoOffsetMethod int QMetaObject::classInfoOffset()
[const]stringclassNameMethod const char *QMetaObject::className()
[const]QMetaMethodconstructor(int index)Method QMetaMethod QMetaObject::constructor(int index)
[const]intconstructorCountMethod int QMetaObject::constructorCount()
[const]new QMetaObject ptrdupCreates a copy of self
[const]QMetaEnumenumerator(int index)Method QMetaEnum QMetaObject::enumerator(int index)
[const]intenumeratorCountMethod int QMetaObject::enumeratorCount()
[const]intenumeratorOffsetMethod int QMetaObject::enumeratorOffset()
[const]intindexOfClassInfo(string name)Method int QMetaObject::indexOfClassInfo(const char *name)
[const]intindexOfConstructor(string constructor)Method int QMetaObject::indexOfConstructor(const char *constructor)
[const]intindexOfEnumerator(string name)Method int QMetaObject::indexOfEnumerator(const char *name)
[const]intindexOfMethod(string method)Method int QMetaObject::indexOfMethod(const char *method)
[const]intindexOfProperty(string name)Method int QMetaObject::indexOfProperty(const char *name)
[const]intindexOfSignal(string signal)Method int QMetaObject::indexOfSignal(const char *signal)
[const]intindexOfSlot(string slot)Method int QMetaObject::indexOfSlot(const char *slot)
[const]QMetaMethodmethod(int index)Method QMetaMethod QMetaObject::method(int index)
[const]intmethodCountMethod int QMetaObject::methodCount()
[const]intmethodOffsetMethod int QMetaObject::methodOffset()
[const]QMetaPropertyproperty(int index)Method QMetaProperty QMetaObject::property(int index)
[const]intpropertyCountMethod int QMetaObject::propertyCount()
[const]intpropertyOffsetMethod int QMetaObject::propertyOffset()
[const]const QMetaObject ptrsuperClassMethod const QMetaObject *QMetaObject::superClass()
[const]stringtr(string s,
string c)
Method QString QMetaObject::tr(const char *s, const char *c)
[const]stringtr(string s,
string c,
int n)
Method QString QMetaObject::tr(const char *s, const char *c, int n)
[const]stringtrUtf8(string s,
string c)
Method QString QMetaObject::trUtf8(const char *s, const char *c)
[const]stringtrUtf8(string s,
string c,
int n)
Method QString QMetaObject::trUtf8(const char *s, const char *c, int n)
[const]QMetaPropertyuserPropertyMethod QMetaProperty QMetaObject::userProperty()

Public static methods and constants

boolcheckConnectArgs(string signal,
string method)
Static method bool QMetaObject::checkConnectArgs(const char *signal, const char *method)
boolconnect(const QObject ptr sender,
int signal_index,
const QObject ptr receiver,
int method_index,
int type = 0,
int ptr types = 0)
Static method bool QMetaObject::connect(const QObject *sender, int signal_index, const QObject *receiver, int method_index, int type, int *types)
voidconnectSlotsByName(QObject ptr o)Static method void QMetaObject::connectSlotsByName(QObject *o)
booldisconnect(const QObject ptr sender,
int signal_index,
const QObject ptr receiver,
int method_index)
Static method bool QMetaObject::disconnect(const QObject *sender, int signal_index, const QObject *receiver, int method_index)
booldisconnectOne(const QObject ptr sender,
int signal_index,
const QObject ptr receiver,
int method_index)
Static method bool QMetaObject::disconnectOne(const QObject *sender, int signal_index, const QObject *receiver, int method_index)
bytesnormalizedSignature(string method)Static method QByteArray QMetaObject::normalizedSignature(const char *method)
bytesnormalizedType(string type)Static method QByteArray QMetaObject::normalizedType(const char *type)

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

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

assign

Signature: void assign (const QMetaObject other)

Description: Assigns another object to self

checkConnectArgs

Signature: [static] bool checkConnectArgs (string signal, string method)

Description: Static method bool QMetaObject::checkConnectArgs(const char *signal, const char *method)

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

classInfo

Signature: [const] QMetaClassInfo classInfo (int index)

Description: Method QMetaClassInfo QMetaObject::classInfo(int index)

classInfoCount

Signature: [const] int classInfoCount

Description: Method int QMetaObject::classInfoCount()

classInfoOffset

Signature: [const] int classInfoOffset

Description: Method int QMetaObject::classInfoOffset()

className

Signature: [const] string className

Description: Method const char *QMetaObject::className()

connect

Signature: [static] bool connect (const QObject ptr sender, int signal_index, const QObject ptr receiver, int method_index, int type = 0, int ptr types = 0)

Description: Static method bool QMetaObject::connect(const QObject *sender, int signal_index, const QObject *receiver, int method_index, int type, int *types)

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

connectSlotsByName

Signature: [static] void connectSlotsByName (QObject ptr o)

Description: Static method void QMetaObject::connectSlotsByName(QObject *o)

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

constructor

Signature: [const] QMetaMethod constructor (int index)

Description: Method QMetaMethod QMetaObject::constructor(int index)

constructorCount

Signature: [const] int constructorCount

Description: Method int QMetaObject::constructorCount()

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.

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: [const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

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.

disconnect

Signature: [static] bool disconnect (const QObject ptr sender, int signal_index, const QObject ptr receiver, int method_index)

Description: Static method bool QMetaObject::disconnect(const QObject *sender, int signal_index, const QObject *receiver, int method_index)

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

disconnectOne

Signature: [static] bool disconnectOne (const QObject ptr sender, int signal_index, const QObject ptr receiver, int method_index)

Description: Static method bool QMetaObject::disconnectOne(const QObject *sender, int signal_index, const QObject *receiver, int method_index)

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

dup

Signature: [const] new QMetaObject ptr dup

Description: Creates a copy of self

enumerator

Signature: [const] QMetaEnum enumerator (int index)

Description: Method QMetaEnum QMetaObject::enumerator(int index)

enumeratorCount

Signature: [const] int enumeratorCount

Description: Method int QMetaObject::enumeratorCount()

enumeratorOffset

Signature: [const] int enumeratorOffset

Description: Method int QMetaObject::enumeratorOffset()

indexOfClassInfo

Signature: [const] int indexOfClassInfo (string name)

Description: Method int QMetaObject::indexOfClassInfo(const char *name)

indexOfConstructor

Signature: [const] int indexOfConstructor (string constructor)

Description: Method int QMetaObject::indexOfConstructor(const char *constructor)

indexOfEnumerator

Signature: [const] int indexOfEnumerator (string name)

Description: Method int QMetaObject::indexOfEnumerator(const char *name)

indexOfMethod

Signature: [const] int indexOfMethod (string method)

Description: Method int QMetaObject::indexOfMethod(const char *method)

indexOfProperty

Signature: [const] int indexOfProperty (string name)

Description: Method int QMetaObject::indexOfProperty(const char *name)

indexOfSignal

Signature: [const] int indexOfSignal (string signal)

Description: Method int QMetaObject::indexOfSignal(const char *signal)

indexOfSlot

Signature: [const] int indexOfSlot (string slot)

Description: Method int QMetaObject::indexOfSlot(const char *slot)

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.

method

Signature: [const] QMetaMethod method (int index)

Description: Method QMetaMethod QMetaObject::method(int index)

methodCount

Signature: [const] int methodCount

Description: Method int QMetaObject::methodCount()

methodOffset

Signature: [const] int methodOffset

Description: Method int QMetaObject::methodOffset()

new

Signature: [static] new QMetaObject new

Description: Constructor QMetaObject::QMetaObject()

This method creates an object of class QMetaObject.

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

normalizedSignature

Signature: [static] bytes normalizedSignature (string method)

Description: Static method QByteArray QMetaObject::normalizedSignature(const char *method)

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

normalizedType

Signature: [static] bytes normalizedType (string type)

Description: Static method QByteArray QMetaObject::normalizedType(const char *type)

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

property

Signature: [const] QMetaProperty property (int index)

Description: Method QMetaProperty QMetaObject::property(int index)

propertyCount

Signature: [const] int propertyCount

Description: Method int QMetaObject::propertyCount()

propertyOffset

Signature: [const] int propertyOffset

Description: Method int QMetaObject::propertyOffset()

superClass

Signature: [const] const QMetaObject ptr superClass

Description: Method const QMetaObject *QMetaObject::superClass()

tr

(1) Signature: [const] string tr (string s, string c)

Description: Method QString QMetaObject::tr(const char *s, const char *c)

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

Description: Method QString QMetaObject::tr(const char *s, const char *c, int n)

trUtf8

(1) Signature: [const] string trUtf8 (string s, string c)

Description: Method QString QMetaObject::trUtf8(const char *s, const char *c)

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

Description: Method QString QMetaObject::trUtf8(const char *s, const char *c, int n)

userProperty

Signature: [const] QMetaProperty userProperty

Description: Method QMetaProperty QMetaObject::userProperty()