KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QMetaType

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QMetaType

Public constructors

new QMetaTypenewConstructor QMetaType::QMetaType()

Public methods

[const]QMetaType ptr_const_castReturns a non-const reference to self.
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 QMetaType other)Assigns another object to self
[const]new QMetaType ptrdupCreates a copy of self

Public static methods and constants

void *construct(int type,
void * copy = 0)
Static method void *QMetaType::construct(int type, const void *copy)
boolisRegistered?(int type)Static method bool QMetaType::isRegistered(int type)
boolload(QDataStream stream,
int type,
void * data)
Static method bool QMetaType::load(QDataStream &stream, int type, void *data)
voidqt_destroy(int type,
void * data)
Static method void QMetaType::destroy(int type, void *data)
boolsave(QDataStream stream,
int type,
void * data)
Static method bool QMetaType::save(QDataStream &stream, int type, const void *data)
inttype(string typeName)Static method int QMetaType::type(const char *typeName)
stringtypeName(int type)Static method const char *QMetaType::typeName(int type)
voidunregisterType(string typeName)Static method void QMetaType::unregisterType(const char *typeName)

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

_const_cast

Signature: [const] QMetaType ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_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 QMetaType other)

Description: Assigns another object to self

construct

Signature: [static] void * construct (int type, void * copy = 0)

Description: Static method void *QMetaType::construct(int type, const void *copy)

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

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 QMetaType ptr dup

Description: Creates a copy of self

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

isRegistered?

Signature: [static] bool isRegistered? (int type)

Description: Static method bool QMetaType::isRegistered(int type)

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

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.

load

Signature: [static] bool load (QDataStream stream, int type, void * data)

Description: Static method bool QMetaType::load(QDataStream &stream, int type, void *data)

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

new

Signature: [static] new QMetaType new

Description: Constructor QMetaType::QMetaType()

This method creates an object of class QMetaType.

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

qt_destroy

Signature: [static] void qt_destroy (int type, void * data)

Description: Static method void QMetaType::destroy(int type, void *data)

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

save

Signature: [static] bool save (QDataStream stream, int type, void * data)

Description: Static method bool QMetaType::save(QDataStream &stream, int type, const void *data)

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

type

Signature: [static] int type (string typeName)

Description: Static method int QMetaType::type(const char *typeName)

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

typeName

Signature: [static] string typeName (int type)

Description: Static method const char *QMetaType::typeName(int type)

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

unregisterType

Signature: [static] void unregisterType (string typeName)

Description: Static method void QMetaType::unregisterType(const char *typeName)

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