QMetaType Class

Documentación de las funciones miembro

[constexpr noexcept, since 6.0] QMetaType::QMetaType()

Construye un objeto QMetaType inválido por defecto.

Esta función se introdujo en Qt 6.0.

[explicit] QMetaType::QMetaType(int typeId)

Construye un objeto QMetaType que contiene toda la información sobre el tipo typeId.

[constexpr, since 6.0] qsizetype QMetaType::alignOf() const

Devuelve la alineación del tipo en bytes (es decir, alignof(T), donde T es el tipo real para el que se construyó esta instancia de QMetaType ).

Esta función se utiliza normalmente junto con construct() para realizar una gestión de bajo nivel de la memoria utilizada por un tipo.

Esta función se introdujo en Qt 6.0.

Véase también QMetaType::construct() y QMetaType::sizeOf().

[static] bool QMetaType::canConvert(QMetaType fromType, QMetaType toType)

Devuelve true si QMetaType::convert puede convertir de fromType a toType. Tenga en cuenta que se trata principalmente de la capacidad de ejecutar la conversión, mientras que la conversión real puede fallar cuando se intenta (por ejemplo, convertir un valor de coma flotante a un entero fuera de su rango).

La función registerConverter() puede utilizarse para registrar conversiones adicionales, ya sea entre un tipo incorporado y uno no incorporado, o entre dos tipos no incorporados. Esta función devolverá true si la ruta de conversión está registrada.

Qt soporta las siguientes conversiones:

Otras conversiones admitidas son entre todos los tipos primitivos (int, float, bool, etc., incluidos todos los enums) y entre cualquier tipo de puntero y std::nullptr_t. Las enumeraciones también pueden convertirse a QString y QByteArray.

Si tanto fromType como toType son tipos derivados de QObject (o punteros a ellos), esta función también devolverá true si uno de los tipos deriva del otro. Es decir, devuelve true si static_cast<> del tipo descrito por fromType al tipo descrito por toType compilaría. La función convert() opera como qobject_cast() y verifica el tipo dinámico del objeto apuntado por QVariant.

Una conversión desde un contenedor secuencial también devolverá true para esta función si el toType es QVariantList.

De forma similar, una conversión desde un contenedor asociativo también devolverá verdadero para esta función si toType es QVariantHash o QVariantMap.

Véase también convert(), QMetaSequence::Iterable, Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE(), QMetaAssociation::Iterable, y Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE().

[static] bool QMetaType::canView(QMetaType fromType, QMetaType toType)

Devuelve true si QMetaType::view puede crear una vista mutable del tipo toType sobre el tipo fromType.

La conversión entre punteros de tipos derivados de QObject devolverá true para esta función si una qobject_cast del tipo descrito por fromType al tipo descrito por toType tendría éxito.

Puede crear una vista mutable de tipo QMetaSequence::Iterable en cualquier contenedor registrado con Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE().

Del mismo modo, puede crear una vista mutable del tipo QMetaAssociation::Iterable en cualquier contenedor registrado con Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE().

Véase también convert(), QMetaSequence::Iterable, Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE(), QMetaAssociation::Iterable, y Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE().

[since 6.0] QPartialOrdering QMetaType::compare(const void *lhs, const void *rhs) const

Compara los objetos en lhs y rhs para ordenarlos.

Devuelve QPartialOrdering::Unordered si no se admite la comparación o los valores no están ordenados. En caso contrario, devuelve QPartialOrdering::Less, QPartialOrdering::Equivalent o QPartialOrdering::Greater si lhs es menor, equivalente o mayor que rhs, respectivamente.

Ambos objetos deben ser del tipo descrito por este metateipo. Si lhs o rhs son nullptr, los valores no están ordenados. La comparación sólo se admite si el operador menos que del tipo era visible en la declaración del metateipo.

Si el operador de igualdad del tipo también era visible, los valores sólo se compararán iguales si el operador de igualdad dice que lo son. En ausencia de un operador de igualdad, cuando ninguno de los valores es menor que el otro, los valores se consideran iguales; si la igualdad también está disponible y dos valores de este tipo no son iguales, se consideran desordenados, al igual que los valores NaN (not a number) de un tipo de coma flotante quedan fuera de su ordenación.

Esta función se introdujo en Qt 6.0.

Véase también equals() y isOrdered().

void *QMetaType::construct(void *where, const void *copy = nullptr) const

Construye un valor del tipo para el que se construyó esta instancia QMetaType en la memoria existente direccionada por where, que es una copia de copy, y devuelve where. Si copy es cero, el valor se construye por defecto.

Esta es una función de bajo nivel para gestionar explícitamente la memoria utilizada para almacenar el tipo. Considere llamar a create() si no necesita este nivel de control (es decir, utilice "new" en lugar de "placement new").

Debe asegurarse de que where apunte a una ubicación en la que se pueda almacenar el nuevo valor y que where esté adecuadamente alineado. El tamaño del tipo puede consultarse llamando a sizeOf().

La regla general para la alineación es que un tipo se alinea a su límite natural, que es la menor potencia de 2 que es mayor que el tipo, a menos que esa alineación sea mayor que la alineación máxima útil para la plataforma. A efectos prácticos, una alineación mayor que 2 * sizeof(void*) sólo es necesaria para instrucciones de hardware especiales (por ejemplo, cargas y almacenamientos SSE alineados en x86).

[static] bool QMetaType::convert(QMetaType fromType, const void *from, QMetaType toType, void *to)

Convierte el objeto en from de fromType al espacio preasignado en to tecleado toType. Devuelve true, si la conversión tuvo éxito, en caso contrario false.

Tanto from como to tienen que ser punteros válidos.

void *QMetaType::create(const void *copy = nullptr) const

Devuelve una copia de copy, asumiendo que es del tipo para el que se creó esta instancia QMetaType. Si copy es nullptr, crea una instancia construida por defecto.

Véase también QMetaType::destroy().

bool QMetaType::debugStream(QDebug &dbg, const void *rhs)

Envía el objeto rhs al flujo de depuración dbg. Devuelve true en caso de éxito, en caso contrario false.

void QMetaType::destroy(void *data) const

Destruye el data, suponiendo que sea del tipo para el que se creó esta instancia QMetaType.

Véase también QMetaType::create().

void QMetaType::destruct(void *data) const

Destruye el valor, localizado en data, asumiendo que es del tipo para el que se construyó esta instancia QMetaType.

A diferencia de destroy(), esta función sólo invoca al destructor del tipo, no invoca al operador delete.

Véase también QMetaType::construct().

[since 6.0] bool QMetaType::equals(const void *lhs, const void *rhs) const

Compara los objetos en lhs y rhs para la igualdad.

Ambos objetos deben ser del tipo descrito por este metateipo. Sólo puede comparar los dos objetos si un operador menor que o de igualdad para el tipo era visible para la declaración del metateipo. En caso contrario, el metateipo nunca considera iguales los valores. Cuando un operador de igualdad era visible para la declaración del metateipo, es autoritativo; de lo contrario, si menos que es visible, cuando ninguno de los valores es menor que el otro, los dos se consideran iguales. Si los valores no están ordenados (véase compare() para más detalles) no son iguales.

Devuelve true si los dos objetos se comparan igual, en caso contrario false.

Esta función se introdujo en Qt 6.0.

Véase también isEqualityComparable() y compare().

[constexpr] QMetaType::TypeFlags QMetaType::flags() const

Devuelve las banderas del tipo para el que se construyó esta instancia de QMetaType. Para inspeccionar rasgos de tipo específicos, prefiera utilizar una de las funciones "is-" en lugar de las banderas directamente.

Véase también QMetaType::TypeFlags, isDefaultConstructible(), isCopyConstructible(), isMoveConstructible(), isDestructible(), isEqualityComparable(), y isOrdered().

[static] QMetaType QMetaType::fromName(QByteArrayView typeName)

Devuelve un QMetaType que coincide con typeName. El objeto devuelto no es válido si el typeName no es conocido por QMetaType

[static constexpr] template <typename T> QMetaType QMetaType::fromType()

Devuelve el QMetaType correspondiente al tipo en el parámetro de plantilla.

[static] bool QMetaType::hasRegisteredConverterFunction(QMetaType fromType, QMetaType toType)

Devuelve true, si el sistema de metatipos tiene una conversión registrada del id de metatipo fromType a toType

[static] template <typename From, typename To> bool QMetaType::hasRegisteredConverterFunction()

Devuelve true, si el metatipo del sistema tiene una conversión registrada del tipo From al tipo To.

[since 6.1] bool QMetaType::hasRegisteredDataStreamOperators() const

Devuelve true, si el sistema de metatipos ha registrado operadores de flujo de datos para este metatipo.

Esta función se introdujo en Qt 6.1.

[since 6.0] bool QMetaType::hasRegisteredDebugStreamOperator() const

Devuelve true, si el sistema de metatipos tiene un operador de flujo de depuración registrado para este metatipo.

Esta función se introdujo en Qt 6.0.

[static] bool QMetaType::hasRegisteredMutableViewFunction(QMetaType fromType, QMetaType toType)

Devuelve true, si el sistema de metatipos tiene una vista mutable registrada en el id de metatipo fromType del id de metatipo toType.

[static, since 6.0] template <typename From, typename To> bool QMetaType::hasRegisteredMutableViewFunction()

Devuelve true, si el meta sistema de tipos tiene una vista mutable registrada en el tipo From del tipo To.

Esta función se introdujo en Qt 6.0.

int QMetaType::id() const

Devuelve el tipo de identificación de esta instancia de QMetaType.

[noexcept, since 6.5] bool QMetaType::isCopyConstructible() const

Devuelve true si este tipo se puede construir con copia. Si se puede, entonces construct() y create() se pueden utilizar con un parámetro copy que no sea nulo.

Esta función se introdujo en Qt 6.5.

Véase también flags(), isDefaultConstructible(), isMoveConstructible() y isDestructible().

[noexcept, since 6.5] bool QMetaType::isDefaultConstructible() const

Devuelve true si este tipo puede construirse por defecto. Si se puede, entonces construct() y create() se pueden utilizar con un parámetro copy que sea null.

Esta función se introdujo en Qt 6.5.

Véase también flags(), isCopyConstructible(), isMoveConstructible(), y isDestructible().

[noexcept, since 6.5] bool QMetaType::isDestructible() const

Devuelve true si este tipo puede ser destruido. Si se puede, entonces se puede llamar a destroy() y destruct().

Esta función se introdujo en Qt 6.5.

Véase también flags(), isDefaultConstructible(), isCopyConstructible(), y isMoveConstructible().

bool QMetaType::isEqualityComparable() const

Devuelve true si un operador menor que o de igualdad para el tipo descrito por este metatipo era visible para la declaración del metatipo, en caso contrario false.

Véase también equals() y isOrdered().

[noexcept, since 6.5] bool QMetaType::isMoveConstructible() const

Devuelve true si este tipo puede ser construido con move. QMetaType actualmente no tiene una API para hacer uso de este rasgo.

Esta función se introdujo en Qt 6.5.

Véase también flags(), isDefaultConstructible(), isCopyConstructible(), y isDestructible().

bool QMetaType::isOrdered() const

Devuelve true si un operador less than para el tipo descrito por este metateipo era visible para la declaración del metateipo, en caso contrario false.

Véase también compare() y isEqualityComparable().

[noexcept] bool QMetaType::isRegistered() const

Devuelve true si este objeto QMetaType ha sido registrado en el registro global de metatodos de Qt. El registro permite encontrar el tipo por su nombre (usando QMetaType::fromName()) o por su ID (usando el constructor).

Véase también qRegisterMetaType() y isValid().

[static] bool QMetaType::isRegistered(int type)

Devuelve true si el tipo de dato con ID type está registrado; en caso contrario devuelve false.

Véase también type() y Type.

[constexpr noexcept] bool QMetaType::isValid() const

Devuelve true si este objeto QMetaType contiene información válida sobre un tipo, false en caso contrario.

Véase también isRegistered().

bool QMetaType::load(QDataStream &stream, void *data) const

Lee el objeto de este tipo del stream dado en data. Devuelve true si el objeto se ha cargado correctamente; en caso contrario devuelve false.

Normalmente, no debería necesitar llamar a esta función directamente. En su lugar, utilice QVariant's operator>>(), que se basa en load() para transmitir tipos personalizados.

Véase también save().

[constexpr] const QMetaObject *QMetaType::metaObject() const

Devuelve un QMetaObject relativo a este tipo.

Si el tipo es un tipo puntero a una subclase de QObject, flags() contiene QMetaType::PointerToQObject y esta función devuelve el QMetaObject correspondiente. Esto puede ser usado en combinación con QMetaObject::newInstance() para crear QObjects de este tipo.

Si el tipo es un Q_GADGET, flags() contiene QMetaType::IsGadget. Si el tipo es un puntero a Q_GADGET, flags() contiene QMetaType::PointerToGadget. En ambos casos, esta función devuelve su QMetaObject. Esto se puede utilizar para recuperar QMetaMethod y QMetaProperty y utilizarlos en un puntero de este tipo, por ejemplo, como se indica en QVariant::data().

Si el tipo es una enumeración, flags() contiene QMetaType::IsEnumeration. En este caso, esta función devuelve el QMetaObject del objeto que lo encierra si la enumeración fue registrada como un Q_ENUM o nullptr en caso contrario.

Véase también QMetaType::flags().

[constexpr] const char *QMetaType::name() const

Devuelve el nombre del tipo asociado a este QMetaType, o un puntero nulo si no se encontró ningún tipo coincidente. El puntero devuelto no debe ser eliminado.

Véase también typeName().

[static] template <typename From, typename To> bool QMetaType::registerConverter()

Registra la posibilidad de una conversión implícita del tipo From al tipo To en el meta type system. Devuelve true si el registro se ha realizado correctamente, en caso contrario false.

class Counter {
  int number = 0;
public:
  int value() const { return number; }
  operator int() const { return value(); }
  void increment() {++number;}
};
QMetaType::registerConverter<Counter, int>();

[static] template <typename From, typename To> bool QMetaType::registerConverter(To (From::*)() const function)

Registra un método function como To From::function() const como conversor del tipo From al tipo To en el meta sistema de tipos. Devuelve true si el registro tuvo éxito, en caso contrario false.

struct Coordinates {
  int x;
  int y;
  int z;

  QString toString() const { return u"[x: %1; y: %2, z: %3]"_s.arg(QString::number(x),
    QString::number(y),
    QString::number(z)); }
};
QMetaType::registerConverter<Coordinates, QString>(&Coordinates::toString);

[static] template <typename From, typename To> bool QMetaType::registerConverter(To (From::*)(bool *) const function)

Registra un método function como To From::function(bool *ok) const como conversor del tipo From al tipo To en el meta sistema de tipos. Devuelve true si el registro tuvo éxito, en caso contrario false.

El puntero ok puede ser utilizado por la función para indicar si la conversión tuvo éxito.

struct BigNumber {
    long long l;

    int toInt(bool *ok = nullptr) const {
      const bool canConvertSafely = l < std::numeric_limits<int>::max();
      if (ok)
        *ok = canConvertSafely;
      return l;
    }
};
QMetaType::registerConverter<BigNumber, int>(&BigNumber::toInt);

[static] template < typename From, typename To, typename UnaryFunction > bool QMetaType::registerConverter(UnaryFunction function)

Registra un objeto de función unario function como convertidor del tipo De al tipo A en el meta sistema de tipos. Devuelve true si el registro tuvo éxito, en caso contrario false.

function debe tomar una instancia del tipo From y devolver una instancia de To. Puede ser un puntero de función, una lambda o un objeto functor. Desde Qt 6.5, function también puede devolver una instancia de std::optional<To> para poder indicar conversiones fallidas.

QMetaType::registerConverter<CustomStringType, QString>([](const CustomStringType &str) {
    return QString::fromUtf8(str.data());
});
QMetaType::registerConverter<QJsonValue, CustomPointType>(
          [](const QJsonValue &value) -> std::optional<CustomPointType> {
    const auto object = value.toObject();
    if (!object.contains("x") || !object.contains("y"))
        return std::nullopt;  // The conversion fails if the required properties are missing
    return CustomPointType{object["x"].toDouble(), object["y"].toDouble()};
});

[static, since 6.0] template <typename From, typename To> bool QMetaType::registerMutableView(To (From::*)() function)

Registra un método function como To From::function() como vista mutable del tipo To sobre el tipo From en el meta sistema de tipos. Devuelve true si el registro tuvo éxito, en caso contrario false.

Esta función se introdujo en Qt 6.0.

[static, since 6.0] template < typename From, typename To, typename UnaryFunction > bool QMetaType::registerMutableView(UnaryFunction function)

Registra un objeto de función unario function como vista mutable del tipo To sobre el tipo From en el meta sistema de tipos. Devuelve true si el registro tuvo éxito, en caso contrario false.

Esta función se introdujo en Qt 6.0.

[since 6.5] void QMetaType::registerType() const

Registra este QMetaType en el registro de tipos para que pueda encontrarse por su nombre, utilizando QMetaType::fromName().

Esta función se introdujo en Qt 6.5.

Véase también qRegisterMetaType().

bool QMetaType::save(QDataStream &stream, const void *data) const

Escribe el objeto apuntado por data en la dirección stream. Devuelve true si el objeto se ha guardado correctamente; en caso contrario, devuelve false.

Normalmente, no debería necesitar llamar a esta función directamente. En su lugar, utilice QVariant's operator<<(), que se basa en save() para transmitir tipos personalizados.

Véase también load().

[constexpr] qsizetype QMetaType::sizeOf() const

Devuelve el tamaño del tipo en bytes (es decir, sizeof(T), donde T es el tipo real para el que se construyó esta instancia de QMetaType ).

Esta función se utiliza normalmente junto con construct() para realizar una gestión de bajo nivel de la memoria utilizada por un tipo.

Véase también QMetaType::construct() y QMetaType::alignOf().

[since 6.6] QMetaType QMetaType::underlyingType() const

Si este metatipo representa una enumeración, este método devuelve un metatipo de una clase numérica con el mismo signo y tamaño que el tipo subyacente de la enumeración. Si representa un tipo QFlags, devuelve QMetaType::Int. En todos los demás casos se devuelve un QMetaType no válido.

Esta función se introdujo en Qt 6.6.

[static, since 6.0] bool QMetaType::view(QMetaType fromType, void *from, QMetaType toType, void *to)

Crea una vista mutable sobre el objeto en from de fromType en el espacio preasignado en to tecleado toType. Devuelve true si la conversión tuvo éxito, en caso contrario false.

Esta función se introdujo en Qt 6.0.