API reference - Class QMetaEnum

Notation used in Ruby API documentation

Description: Binding of QMetaEnum

Public constructors

new QMetaEnumnewConstructor QMetaEnum::QMetaEnum()

Public methods

[const]voidassign(const QMetaEnum other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QMetaEnumdupCreates a copy of self
[const]const QMetaObject ptrenclosingMetaObjectMethod const QMetaObject *QMetaEnum::enclosingMetaObject()
[const]boolisFlagMethod bool QMetaEnum::isFlag()
[const]boolisFlag?Method bool QMetaEnum::isFlag()
[const]boolisValidMethod bool QMetaEnum::isValid()
[const]boolisValid?Method bool QMetaEnum::isValid()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]stringkey(int index)Method const char *QMetaEnum::key(int index)
[const]intkeyCountMethod int QMetaEnum::keyCount()
[const]intkeyToValue(string key)Method int QMetaEnum::keyToValue(const char *key)
[const]intkeysToValue(string keys)Method int QMetaEnum::keysToValue(const char *keys)
[const]stringnameMethod const char *QMetaEnum::name()
[const]stringscopeMethod const char *QMetaEnum::scope()
[const]intvalue(int index)Method int QMetaEnum::value(int index)
[const]stringvalueToKey(int value)Method const char *QMetaEnum::valueToKey(int value)
[const]stringvalueToKeys(int value)Method QByteArray QMetaEnum::valueToKeys(int value)

Detailed description

[const] void assign(const QMetaEnum other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

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

[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] QMetaEnum dup

Description: Creates a copy of self

[const] const QMetaObject ptr enclosingMetaObject

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

[const] bool isFlag

Description: Method bool QMetaEnum::isFlag()

[const] bool isFlag?

Description: Method bool QMetaEnum::isFlag()

[const] bool isValid

Description: Method bool QMetaEnum::isValid()

[const] bool isValid?

Description: Method bool QMetaEnum::isValid()

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

[const] string key(int index)

Description: Method const char *QMetaEnum::key(int index)

[const] int keyCount

Description: Method int QMetaEnum::keyCount()

[const] int keyToValue(string key)

Description: Method int QMetaEnum::keyToValue(const char *key)

[const] int keysToValue(string keys)

Description: Method int QMetaEnum::keysToValue(const char *keys)

[const] string name

Description: Method const char *QMetaEnum::name()

[static] new QMetaEnum new

Description: Constructor QMetaEnum::QMetaEnum()

This method creates an object of class QMetaEnum.

[const] string scope

Description: Method const char *QMetaEnum::scope()

[const] int value(int index)

Description: Method int QMetaEnum::value(int index)

[const] string valueToKey(int value)

Description: Method const char *QMetaEnum::valueToKey(int value)

[const] string valueToKeys(int value)

Description: Method QByteArray QMetaEnum::valueToKeys(int value)