PySide6.QtCore.QMetaEnum¶

class QMetaEnum¶

The QMetaEnum class provides meta-data about an enumerator.

Details

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.

To use QMetaEnum functionality, register the enumerator within the meta-object system using the Q_ENUM macro.

enum AppleType {
    Big,
    Small
};
Q_ENUM(AppleType)

QMetaEnum metaEnum = QMetaEnum::fromType<ModelApple::AppleType>();
qDebug() << metaEnum.valueToKey(ModelApple::Big);

Synopsis¶

Methods¶

def __init__()
def enumName()
def is64Bit()
def isFlag()
def isScoped()
def isValid()
def key()
def keyCount()
def keyToValue()
def keysToValue()
def metaType()
def name()
def scope()
def value()
def valueToKey()
def valueToKeys()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

__init__()¶

enumName()¶

Return type:: str

Returns the enum name of the flag (without the scope).

For example, the AlignmentFlag flag has AlignmentFlag as the enum name, but Alignment as the type name. Non flag enums has the same type and enum names.

Enum names have the same scope as the type name.

See also

isValid() name()

is64Bit()¶

Return type:: bool

Returns true if the underlying type of this enumeration is 64 bits wide.

See also

value64()

isFlag()¶

Return type:: 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()¶

Return type:: bool

Returns true if this enumerator is declared as a C++11 enum class; otherwise returns false.

isValid()¶

Return type:: bool

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

See also

name()

key(index)¶

Parameters:: index – int
Return type:: str

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

See also

keyCount() value() valueToKey()

keyCount()¶

Return type:: int

Returns the number of keys.

See also

key()

keyToValue(key)¶

Parameters:: key – str
Return type:: PyTuple

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

If key is not defined, *``ok`` is set to false; otherwise *``ok`` is set to true.

For flag types, use keysToValue() .

If this is a 64-bit enumeration (see is64Bit() ), this function returns the low 32-bit portion of the value. Use keyToValue64() to obtain the full value instead.

See also

keyToValue64 valueToKey() isFlag() keysToValue() is64Bit()

keysToValue(keys)¶

Parameters:: keys – str
Return type:: PyTuple

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.

If keys is not defined, *``ok`` is set to false; otherwise *``ok`` is set to true.

If this is a 64-bit enumeration (see is64Bit() ), this function returns the low 32-bit portion of the value. Use keyToValue64() to obtain the full value instead.

See also

keysToValue64() isFlag() valueToKey() valueToKeys() is64Bit()

metaType()¶

Return type:: QMetaType

Returns the meta type of the enum.

If the QMetaObject that this enum is part of was generated with Qt 6.5 or earlier, this will be an invalid meta type.

Note

This is the meta type of the enum itself, not of its underlying integral type. You can retrieve the meta type of the underlying type of the enum using underlyingType() .

name()¶

Return type:: 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() enumName()

scope()¶

Return type:: 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(index)¶

Parameters:: index – int
Return type:: int

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

If this is an enumeration with a 64-bit underlying type (see is64Bit() ), this function returns the low 32-bit portion of the value. Use value64() to obtain the full value instead.

See also

value64() keyCount() key() keyToValue()

valueToKey(value)¶

Parameters:: value – int
Return type:: str

Returns the string that is used as the name of the given enumeration value, or None if value is not defined.

For flag types, use valueToKeys() .

See also

isFlag() valueToKeys()

valueToKeys(value)¶

Parameters:: value – int
Return type:: QByteArray

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

Note

Passing a 64-bit value to an enumeration whose underlying type is 32-bit (that is, if is64Bit() returns false) results in an empty string being returned.