Класс QMetaEnum

Класс QMetaEnum предоставляет метаданные об перечислении. Подробнее...

• Список всех членов, включая унаследованные

Открытые функции

Статические открытые члены

Подробное описание

Используйте name() для имени перечисления. Ключи перечисления (имена каждого элемента) возвращаются функцией key(); используйте keyCount() для определения количества ключей. isFlag() возвращает значение true, если перечисление предназначено для использования в качестве флага, то есть его значения можно объединять с помощью оператора ИЛИ.

Функции преобразования keyToValue(), valueToKey(), keysToValue() и valueToKeys() позволяют преобразовывать между целочисленным представлением значения перечисления или набора значений и его текстовым представлением. Функция scope() возвращает область видимости класса, в котором было объявлено это перечисление.

См. также QMetaObject, QMetaMethod и QMetaProperty.

Документация по функциям-членам

const char *QMetaEnum::enumName() const

Возвращает имя перечисления флага (без области видимости).

Например, у флага Qt::AlignmentFlag имя перечисления AlignmentFlag, а имя типа Alignment. Для перечислений, не являющихся флагами, имена типа и перечисления совпадают.

Имена перечислений имеют ту же область видимости, что и имя типа.

Функция была добавлена в Qt 5.12.

См. также isValid() и name().

[static] QMetaEnum QMetaEnum::fromType()

Возвращает QMetaEnum, соответствующий типу в шаблоне. Перечисление должно быть объявлено с помощью Q_ENUM.

Функция была добавлена в Qt 5.5.

bool QMetaEnum::isFlag() const

Возвращает true, если это перечисление используется в качестве флага; в противном случае возвращает false.

При использовании в качестве флагов перечисления могут быть объединены с помощью оператора ИЛИ.

См. также keysToValue() и valueToKeys().

bool QMetaEnum::isScoped() const

Возвращает true, если это перечисление объявлено как C++11 enum class; в противном случае возвращает false.

Функция была добавлена в Qt 5.8.

bool QMetaEnum::isValid() const

Возвращает true, если это перечисление валидно (имеет имя); в противном случае возвращает false.

См. также name().

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

Возвращает ключ с заданным index или nullptr, если такого ключа нет.

См. также keyCount(), value() и valueToKey().

int QMetaEnum::keyCount() const

Возвращает количество ключей.

См. также key().

int QMetaEnum::keyToValue(const char *key, bool *ok = nullptr) const

Возвращает целочисленное значение заданного ключа перечисления, или -1, если key не определен.

Если key не определен, *ok устанавливается в false; в противном случае *ok устанавливается в true.

Для типов флагов используйте keysToValue().

См. также valueToKey(), isFlag() и keysToValue().

int QMetaEnum::keysToValue(const char *keys, bool *ok = nullptr) const

Возвращает значение, полученное путем объединения значений ключей keys с использованием оператора ИЛИ, или -1, если keys не определен. Обратите внимание, что строки в keys должны быть разделены символом '|'.

Если keys не определен, *ok устанавливается в false; в противном случае *ok устанавливается в true.

См. также isFlag(), valueToKey() и valueToKeys().

const char *QMetaEnum::name() const

Возвращает имя типа (без области видимости).

Например, для перечисления Qt::Key имя типа Key, а область видимости — Qt.

Для флагов возвращается имя типа флага, а не имя типа перечисления.

См. также isValid(), scope() и enumName().

const char *QMetaEnum::scope() const

Возвращает область видимости, в которой было объявлено это перечисление.

Например, для перечисления Qt::AlignmentFlag область видимости Qt, а имя AlignmentFlag.

См. также name().

int QMetaEnum::value(int index) const

Возвращает значение с заданным index; или возвращает -1, если такого значения нет.

См. также keyCount(), key() и keyToValue().

const char *QMetaEnum::valueToKey(int value) const

Возвращает строку, используемую в качестве имени заданного значения перечисления value, или nullptr, если value не определено.

Для типов флагов используйте valueToKeys().

См. также isFlag() и valueToKeys().

QByteArray QMetaEnum::valueToKeys(int value) const

Возвращает массив байтов с ключами, разделенными символом '|', представляющих заданное значение value.

См. также isFlag(), valueToKey() и keysToValue().