QMetaEnum¶

PyQt5.QtCore.QMetaEnum

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.

Methods¶

__init__(): TODO

__init__(QMetaEnum): TODO

enumName() → str: TODO

isFlag() → bool

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

isScoped() → bool: TODO

isValid() → bool: TODO

key(int) → str: Returns the key with the given index, or 0 if no such key exists.

See also

keyCount(), value(), valueToKey().

keyCount() → int: Returns the number of keys.

See also

key().

keysToValue(str) → (int, bool): TODO

keyToValue(str) → (int, bool): TODO

name() → str

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

For example, the Key enumeration has Key as the type name and Qt as the scope.

For flags this returns the name of the flag type, not the name of the enum type.

See also

isValid(), scope().

scope() → str

Returns the scope this enumerator was declared in.

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

See also

name().

value(int) → int: Returns the value with the given index; or returns -1 if there is no such value.

See also

keyCount(), key(), keyToValue().

valueToKey(int) → str

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

valueToKeys(int) → QByteArray: Returns a byte array of ‘|’-separated keys that represents the given value.

See also

isFlag(), valueToKey(), keysToValue().