QMetaEnum Class
La clase QMetaEnum proporciona metadatos sobre un enumerador. Más información...
| Cabecera: | #include <QMetaEnum> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Core) target_link_libraries(mytarget PRIVATE Qt6::Core) |
| qmake: | QT += core |
Funciones públicas
| const char * | enumName() const |
(since 6.9) bool | is64Bit() const |
| bool | isFlag() const |
| bool | isScoped() const |
| bool | isValid() const |
| const char * | key(int index) const |
| int | keyCount() const |
(since 6.9) std::optional<quint64> | keyToValue64(const char *key) const |
| int | keyToValue(const char *key, bool *ok = nullptr) const |
| std::optional<quint64> | keysToValue64(const char *keys) const |
| int | keysToValue(const char *keys, bool *ok = nullptr) const |
(since 6.6) QMetaType | metaType() const |
| const char * | name() const |
| const char * | scope() const |
(since 6.9) std::optional<quint64> | value64(int index) const |
| int | value(int index) const |
| const char * | valueToKey(quint64 value) const |
| QByteArray | valueToKeys(quint64 value) const |
Miembros públicos estáticos
| QMetaEnum | fromType() |
Descripción detallada
Utiliza name() para obtener el nombre del enumerador. Las claves del enumerador (los nombres de cada elemento enumerado) se obtienen mediante key(); utiliza keyCount() para averiguar el número de claves. isFlag() indica si el enumerador está pensado para utilizarse como un indicador, lo que significa que sus valores pueden combinarse utilizando el operador OR.
Las funciones de conversión keyToValue(), valueToKey(), keysToValue() y valueToKeys() permiten la conversión entre la representación entera de un valor de enumeración o de conjunto y su representación literal. La función scope() devuelve el ámbito de clase en el que se declaró este enumerador.
Para utilizar la funcionalidad de QMetaEnum, hay que registrar el enumerador en el sistema de metaobjetos mediante la macro ` Q_ENUM `.
Véase también QMetaObject, QMetaMethod y QMetaProperty.
Documentación de funciones de miembro
const char *QMetaEnum::enumName() const
Devuelve el nombre de la enumeración de la bandera (sin el ámbito).
Por ejemplo, el indicador « Qt::AlignmentFlag » tiene « AlignmentFlag » como nombre de enumeración, pero « Alignment » como nombre de tipo. Las enumeraciones que no son indicadores tienen los mismos nombres de tipo y de enumeración.
Los nombres de enumeración tienen el mismo ámbito que el nombre del tipo.
Véase también isValid() y name().
[static] template <typename T> QMetaEnum QMetaEnum::fromType()
Devuelve la enumeración « QMetaEnum » correspondiente al tipo indicado en el parámetro de plantilla. La enumeración debe declararse con « Q_ENUM ».
[since 6.9] bool QMetaEnum::is64Bit() const
Devuelve ` true ` si el tipo subyacente de esta enumeración tiene una anchura de 64 bits.
Esta función se introdujo en Qt 6.9.
Véase también value64().
bool QMetaEnum::isFlag() const
Devuelve « true » si este enumerador se utiliza como indicador; en caso contrario, devuelve «false».
Cuando se utilizan como indicadores, los enumeradores se pueden combinar mediante el operador OR.
Véase también keysToValue() y valueToKeys().
bool QMetaEnum::isScoped() const
Devuelve « true » si este enumerador está declarado como una clase de enumeración de C++11; en caso contrario, devuelve «false».
bool QMetaEnum::isValid() const
Devuelve « true » si esta enumeración es válida (tiene un nombre); en caso contrario, devuelve «false».
Véase también name().
const char *QMetaEnum::key(int index) const
Devuelve la clave con el index indicado, o nullptr si dicha clave no existe.
Véanse también keyCount(), value() y valueToKey().
int QMetaEnum::keyCount() const
Devuelve el número de claves.
Véase también key().
[since 6.9] std::optional<quint64> QMetaEnum::keyToValue64(const char *key) const
Devuelve el valor entero de la enumeración indicada: ` key` o ` std::nullopt ` si ` key ` no está definido.
Para los tipos de indicador, utilice keysToValue64().
Esta función siempre amplía el signo del valor de las enumeraciones de 32 bits a 64 bits, si su tipo subyacente es con signo (por ejemplo, int, short). En la mayoría de los casos, este es el comportamiento esperado.
Una excepción notable son los valores de indicador que tienen el bit 31 activado, como 0x8000'0000, ya que algunos compiladores (como Microsoft Visual Studio) no cambian automáticamente a un tipo subyacente sin signo. Para evitar este problema, especifica explícitamente el tipo subyacente en la declaración de enum.
Nota: Para los QMetaObjects compilados antes de Qt 6.6, esta función siempre realiza una extensión de signo.
Esta función se introdujo en Qt 6.9.
Véase también valueToKey(), isFlag() y keysToValue64().
int QMetaEnum::keyToValue(const char *key, bool *ok = nullptr) const
Devuelve el valor entero de la enumeración dada key, o -1 si key no está definida.
Si key no está definida, *ok se establece en false; en caso contrario, *ok se establece en true.
Para los tipos de indicador, utilice keysToValue().
Si se trata de una enumeración de 64 bits (véase is64Bit()), esta función devuelve los 32 bits menos significativos del valor. Utiliza keyToValue64() para obtener el valor completo.
Véanse también keyToValue64, valueToKey(), isFlag(), keysToValue() y is64Bit().
std::optional<quint64> QMetaEnum::keysToValue64(const char *keys) const
Devuelve el valor obtenido al combinar los valores de ` keys ` mediante el operador OR, o ` std::nullopt ` si ` keys ` no está definido. Ten en cuenta que las cadenas de ` keys ` deben estar separadas por «|».
Esta función siempre amplía el signo del valor de las enumeraciones de 32 bits a 64 bits, si su tipo subyacente es con signo (por ejemplo, int, short). En la mayoría de los casos, este es el comportamiento esperado.
Una excepción destacable son los valores de indicador que tienen el bit 31 activado, como 0x8000'0000, ya que algunos compiladores (como Microsoft Visual Studio) no cambian automáticamente a un tipo subyacente sin signo. Para evitar este problema, especifica explícitamente el tipo subyacente en la declaración de enum.
Nota: Para los QMetaObjects compilados antes de Qt 6.6, esta función siempre realiza una extensión de signo.
Véase también isFlag(), valueToKey() y valueToKeys().
int QMetaEnum::keysToValue(const char *keys, bool *ok = nullptr) const
Devuelve el valor resultante de combinar los valores de « keys » mediante el operador OR, o -1 si « keys » no está definido. Ten en cuenta que las cadenas de « keys » deben estar separadas por «|».
Si keys no está definido, *ok se establece en false; en caso contrario, *ok se establece en true.
Si se trata de una enumeración de 64 bits (véase is64Bit()), esta función devuelve los 32 bits menos significativos del valor. Utilice keyToValue64() para obtener el valor completo.
Véanse también keysToValue64(), isFlag(), valueToKey(), valueToKeys() y is64Bit().
[since 6.6] QMetaType QMetaEnum::metaType() const
Devuelve el metatipo de la enumeración.
Si el archivo « QMetaObject » del que forma parte esta enumeración se generó con Qt 6.5 o una versión anterior, este metatipo no será válido.
Nota: Se trata del metatipo de la propia enumeración, no del tipo entero subyacente. Puedes obtener el metatipo del tipo subyacente de la enumeración utilizando QMetaType::underlyingType().
Esta función se introdujo en Qt 6.6.
const char *QMetaEnum::name() const
Devuelve el nombre del tipo (sin el ámbito).
Por ejemplo, la enumeración « Qt::Key » tiene « Key » como nombre de tipo y « Qt » como ámbito.
En el caso de los indicadores, devuelve el nombre del tipo de indicador, no el nombre del tipo de enumeración.
Véase también isValid(), scope() y enumName().
const char *QMetaEnum::scope() const
Devuelve el ámbito en el que se declaró este enumerador.
Por ejemplo, la enumeración « Qt::AlignmentFlag » tiene como ámbito « Qt » y como nombre « AlignmentFlag ».
Véase también name().
[since 6.9] std::optional<quint64> QMetaEnum::value64(int index) const
Devuelve el valor con el « index » especificado, si existe; o bien devuelve un « std::nullopt » si no existe.
Esta función siempre amplía el signo del valor de las enumeraciones de 32 bits a 64 bits, si su tipo subyacente es con signo (por ejemplo, int, short). En la mayoría de los casos, este es el comportamiento esperado.
Una excepción destacable son los valores de indicador que tienen el bit 31 activado, como 0x8000'0000, ya que algunos compiladores (como Microsoft Visual Studio) no cambian automáticamente a un tipo subyacente sin signo. Para evitar este problema, especifica explícitamente el tipo subyacente en la declaración de enum.
Nota: Para los QMetaObjects compilados antes de Qt 6.6, esta función siempre realiza una extensión de signo.
Esta función se introdujo en Qt 6.9.
Véase también keyCount(), key(), keyToValue() y is64Bit().
int QMetaEnum::value(int index) const
Devuelve el valor con el index especificado; o bien devuelve -1 si no existe dicho valor.
Si se trata de una enumeración con un tipo subyacente de 64 bits (véase is64Bit()), esta función devuelve los 32 bits menos significativos del valor. Utilice value64() para obtener el valor completo.
Véase también value64(), keyCount(), key() y keyToValue().
const char *QMetaEnum::valueToKey(quint64 value) const
Devuelve la cadena que se utiliza como nombre de la enumeración indicada: value, o nullptr si value no está definida.
Para los tipos de indicador, utilice valueToKeys().
Véase también isFlag() y valueToKeys().
QByteArray QMetaEnum::valueToKeys(quint64 value) const
Devuelve una matriz de bytes con claves separadas por «|» que representa el value dado.
Nota: Si se pasa un ` value ` de 64 bits a una enumeración cuyo tipo subyacente es de 32 bits (es decir, si ` is64Bit()` devuelve ` false`), se devuelve una cadena vacía.
Véanse también isFlag(), valueToKey() y keysToValue().
© 2026 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.