|  | Home · All Classes · Modules

# QMetaEnum Class Reference
[QtCore module]

The QMetaEnum class provides meta-data about an enumerator. More...

### Methods

- __init__ (self)
- __init__ (self, QMetaEnum)
- bool isFlag (self)
- bool isValid (self)
- str key (self, int index)
- int keyCount (self)
- int keysToValue (self, str keys)
- int keyToValue (self, str key)
- str name (self)
- str scope (self)
- int value (self, int index)
- str valueToKey (self, int value)
- QByteArray valueToKeys (self, int value)

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

## Method Documentation

### QMetaEnum.__init__ (self)

### QMetaEnum.__init__ (self, QMetaEnum)

### bool QMetaEnum.isFlag (self)

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 (self)

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

See also name().

### str QMetaEnum.key (self, int index)

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

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

### int QMetaEnum.keyCount (self)

Returns the number of keys.

See also key().

### int QMetaEnum.keysToValue (self, str keys)

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

### int QMetaEnum.keyToValue (self, str key)

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

### str QMetaEnum.name (self)

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

### str QMetaEnum.scope (self)

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 (self, int index)

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

See also keyCount(), key(), and keyToValue().

### str QMetaEnum.valueToKey (self, int value)

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 (self, int value)

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

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