API reference - Class QMetaMethod

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QMetaMethod

Sub-classes: Access, QFlags_Access, MethodType, QFlags_MethodType

Public constructors

new QMetaMethodnewConstructor QMetaMethod::QMetaMethod()

Public methods

[const]bool!=(const QMetaMethod m2)Operator bool ::operator!=(const QMetaMethod &m1, const QMetaMethod &m2)
[const]bool==(const QMetaMethod m2)Operator bool ::operator==(const QMetaMethod &m1, const QMetaMethod &m2)
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.
[const]QMetaMethod_AccessaccessMethod QMetaMethod::Access QMetaMethod::access()
voidassign(const QMetaMethod other)Assigns another object to self
[const]intattributesMethod int QMetaMethod::attributes()
[const]new QMetaMethod ptrdupCreates a copy of self
[const]const QMetaObject ptrenclosingMetaObjectMethod const QMetaObject *QMetaMethod::enclosingMetaObject()
[const]voidgetParameterTypes(int ptr types)Method void QMetaMethod::getParameterTypes(int *types)
[const]boolisValid?Method bool QMetaMethod::isValid()
[const]intmethodIndexMethod int QMetaMethod::methodIndex()
[const]bytesmethodSignatureMethod QByteArray QMetaMethod::methodSignature()
[const]QMetaMethod_MethodTypemethodTypeMethod QMetaMethod::MethodType QMetaMethod::methodType()
[const]bytesnameMethod QByteArray QMetaMethod::name()
[const]intparameterCountMethod int QMetaMethod::parameterCount()
[const]bytes[]parameterNamesMethod QList<QByteArray> QMetaMethod::parameterNames()
[const]intparameterType(int index)Method int QMetaMethod::parameterType(int index)
[const]bytes[]parameterTypesMethod QList<QByteArray> QMetaMethod::parameterTypes()
[const]intreturnTypeMethod int QMetaMethod::returnType()
[const]intrevisionMethod int QMetaMethod::revision()
[const]stringtagMethod const char *QMetaMethod::tag()
[const]stringtypeNameMethod const char *QMetaMethod::typeName()

Public static methods and constants

[static,const]QMetaMethod_MethodTypeConstructorEnum constant QMetaMethod::Constructor
[static,const]QMetaMethod_MethodTypeMethodEnum constant QMetaMethod::Method
[static,const]QMetaMethod_AccessPrivateEnum constant QMetaMethod::Private
[static,const]QMetaMethod_AccessProtectedEnum constant QMetaMethod::Protected
[static,const]QMetaMethod_AccessPublicEnum constant QMetaMethod::Public
[static,const]QMetaMethod_MethodTypeSignalEnum constant QMetaMethod::Signal
[static,const]QMetaMethod_MethodTypeSlotEnum constant QMetaMethod::Slot

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

!=

Signature: [const] bool != (const QMetaMethod m2)

Description: Operator bool ::operator!=(const QMetaMethod &m1, const QMetaMethod &m2)

This is the mapping of the global operator to the instance method.

==

Signature: [const] bool == (const QMetaMethod m2)

Description: Operator bool ::operator==(const QMetaMethod &m1, const QMetaMethod &m2)

This is the mapping of the global operator to the instance method.

Constructor

Signature: [static,const] QMetaMethod_MethodType Constructor

Description: Enum constant QMetaMethod::Constructor

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

Method

Signature: [static,const] QMetaMethod_MethodType Method

Description: Enum constant QMetaMethod::Method

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

Private

Signature: [static,const] QMetaMethod_Access Private

Description: Enum constant QMetaMethod::Private

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

Protected

Signature: [static,const] QMetaMethod_Access Protected

Description: Enum constant QMetaMethod::Protected

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

Public

Signature: [static,const] QMetaMethod_Access Public

Description: Enum constant QMetaMethod::Public

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

Signal

Signature: [static,const] QMetaMethod_MethodType Signal

Description: Enum constant QMetaMethod::Signal

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

Slot

Signature: [static,const] QMetaMethod_MethodType Slot

Description: Enum constant QMetaMethod::Slot

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

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

access

Signature: [const] QMetaMethod_Access access

Description: Method QMetaMethod::Access QMetaMethod::access()

assign

Signature: void assign (const QMetaMethod other)

Description: Assigns another object to self

attributes

Signature: [const] int attributes

Description: Method int QMetaMethod::attributes()

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.

dup

Signature: [const] new QMetaMethod ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

enclosingMetaObject

Signature: [const] const QMetaObject ptr enclosingMetaObject

Description: Method const QMetaObject *QMetaMethod::enclosingMetaObject()

getParameterTypes

Signature: [const] void getParameterTypes (int ptr types)

Description: Method void QMetaMethod::getParameterTypes(int *types)

isValid?

Signature: [const] bool isValid?

Description: Method bool QMetaMethod::isValid()

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.

methodIndex

Signature: [const] int methodIndex

Description: Method int QMetaMethod::methodIndex()

methodSignature

Signature: [const] bytes methodSignature

Description: Method QByteArray QMetaMethod::methodSignature()

methodType

Signature: [const] QMetaMethod_MethodType methodType

Description: Method QMetaMethod::MethodType QMetaMethod::methodType()

name

Signature: [const] bytes name

Description: Method QByteArray QMetaMethod::name()

new

Signature: [static] new QMetaMethod new

Description: Constructor QMetaMethod::QMetaMethod()

This method creates an object of class QMetaMethod.

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

parameterCount

Signature: [const] int parameterCount

Description: Method int QMetaMethod::parameterCount()

parameterNames

Signature: [const] bytes[] parameterNames

Description: Method QList<QByteArray> QMetaMethod::parameterNames()

parameterType

Signature: [const] int parameterType (int index)

Description: Method int QMetaMethod::parameterType(int index)

parameterTypes

Signature: [const] bytes[] parameterTypes

Description: Method QList<QByteArray> QMetaMethod::parameterTypes()

returnType

Signature: [const] int returnType

Description: Method int QMetaMethod::returnType()

revision

Signature: [const] int revision

Description: Method int QMetaMethod::revision()

tag

Signature: [const] string tag

Description: Method const char *QMetaMethod::tag()

typeName

Signature: [const] string typeName

Description: Method const char *QMetaMethod::typeName()