QMetaEnum Class Reference

Member Function 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() and valueToKeys().

bool QMetaEnum::isValid () const

Returns true if this enum is valid (has a name); otherwise returns false.

See also name().

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

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

See also keyCount(), value(), and valueToKey().

int QMetaEnum::keyCount () const

Returns the number of keys.

See also key().

int QMetaEnum::keyToValue ( const char * 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(), and keysToValue().

int QMetaEnum::keysToValue ( const char * 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. Note that the strings in keys must be '|'-separated.

See also isFlag(), valueToKey(), and valueToKeys().

const char * QMetaEnum::name () const

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

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

See also isValid() and scope().

const char * QMetaEnum::scope () const

Returns the scope this enumerator was declared in.

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

See also name().

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(), and keyToValue().

const char * 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() and valueToKeys().

QByteArray QMetaEnum::valueToKeys ( int value ) const

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

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