CopperSpice API  1.7.2
QMetaEnum Class Reference

Provides meta data about an enumerator. More...

Public Methods

bool isFlag () const
bool isValid () const
const QStringkey (int index) const
int keyCount () const
int keysToValue (const QString &keys) const
int keyToValue (const QString &key) const
const QStringname () const
const QStringscope () const
int value (int index) const
const QStringvalueToKey (int value) const
QString valueToKeys (int value) const

Detailed Description

The QMetaEnum class provides meta data about an enumerator.

Use name() for the enumerator's name. The enumerator's keys (names of each enumerated item) are returned by key(); use keyCount() to find the number of keys. isFlag() returns whether the enumerator is meant to be used as a flag, meaning that its values can be combined using the OR operator.

The conversion functions keyToValue(), valueToKey(), keysToValue(), and valueToKeys() allow conversion between the integer representation of an enumeration or set value and its literal representation. The scope() function returns the class scope this enumerator was declared in.

See also
QMetaObject, QMetaMethod, QMetaProperty

Method Documentation

bool QMetaEnum::isFlag ( ) const

Returns true if this enumerator is used as a flag, otherwise returns false. When used as flags, enumerators can be combined using the OR operator.

See also
keysToValue(), valueToKeys()
bool QMetaEnum::isValid ( ) const

Returns true if this enum is valid and has a name, otherwise returns false.

See also
const QString & QMetaEnum::key ( int  index) const

Returns the key with the given index or 0 if no such key exists.

See also
keyCount(), value(), valueToKey()
int QMetaEnum::keyCount ( ) const

Returns the number of keys.

See also
int QMetaEnum::keysToValue ( const QString keys) const

Returns the value derived from combining together the values of the keys using the OR operator, or -1 if keys is not defined. The strings in keys must be '|'-separated.

See also
isFlag(), valueToKey(), valueToKeys()
int QMetaEnum::keyToValue ( const QString key) const

Returns the integer value of the given enumeration key, or -1 if key is not defined.

For flag types, use keysToValue().

See also
valueToKey(), isFlag(), keysToValue()
const QString & QMetaEnum::name ( ) const

Returns the name of the enumerator (without the scope).

For example, the Qt::AlignmentFlag enumeration has AlignmentFlag as the name.

See also
isValid(), scope()
const QString & QMetaEnum::scope ( ) const

Returns the scope this enumerator was declared in. For example the Qt::AlignmentFlag enumeration has Qt as the scope.

See also
int QMetaEnum::value ( int  index) const

Returns the value with the given index, or returns -1 if there is no such value.

See also
keyCount(), key(), keyToValue()
const QString & QMetaEnum::valueToKey ( int  value) const

Returns the string that is used as the name of the given enumeration value or 0 if value is not defined. For flag types use valueToKeys().

See also
isFlag(), valueToKeys()
QString QMetaEnum::valueToKeys ( int  value) const

Returns a byte array of '|'-separated keys that represents the given values.

See also
isFlag(), valueToKey(), keysToValue()