The QMetaEnum class provides meta-data about an enumerator. More...
|CMake:|| find_package(Qt6 COMPONENTS Core REQUIRED) |
target_link_libraries(mytarget PRIVATE Qt6::Core)
|qmake:||QT += core|
|const char *||enumName() const|
|const char *||key(int index) const|
|int||keyToValue(const char *key, bool *ok = nullptr) const|
|int||keysToValue(const char *keys, bool *ok = nullptr) const|
|const char *||name() const|
|const char *||scope() const|
|int||value(int index) const|
|const char *||valueToKey(int value) const|
|QByteArray||valueToKeys(int value) const|
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.
Member Function Documentation
Returns the enum name of the flag (without the scope).
For example, the Qt::AlignmentFlag flag has
AlignmentFlag as the enum name, but
Alignment as as the type name. Non flag enums has the same type and enum names.
Enum names have the same scope as the type name.
This function was introduced in Qt 5.12.
This function was introduced in Qt 5.5.
true if this enumerator is used as a flag; otherwise returns false.
When used as flags, enumerators can be combined using the OR operator.
true if this enumerator is declared as a C++11 enum class; otherwise returns false.
This function was introduced in Qt 5.8.
true if this enum is valid (has a name); otherwise returns false.
See also name().
Returns the key with the given index, or
nullptr if no such key exists.
Returns the number of keys.
See also key().
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().
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.
Returns the name of the type (without the scope).
For flags this returns the name of the flag type, not the name of the enum type.
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().
Returns the value with the given index; or returns -1 if there is no such value.
Returns the string that is used as the name of the given enumeration value, or
nullptr if value is not defined.
For flag types, use valueToKeys().
QByteArray QMetaEnum::valueToKeys(int value) const
Returns a byte array of '|'-separated keys that represents the given value.
© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.