QMetaType Class

成员函数文档

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

构造一个默认的、无效的 QMetaType 对象。

该函数在 Qt 6.0 中引入。

[explicit] QMetaType::QMetaType(int typeId)

构造一个 QMetaType 对象，其中包含有关typeId 类型的所有信息。

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

以字节为单位返回类型的对齐方式（即 alignof(T)，其中 T 是该QMetaType 实例的实际类型）。

该函数通常与construct() 一起使用，对类型使用的内存进行底层管理。

该函数在 Qt 6.0 中引入。

另请参阅 QMetaType::construct() 和QMetaType::sizeOf()。

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

如果QMetaType::convert 可以将fromType 转换为toType ，则返回true 。请注意，这主要是指执行转换的能力，而实际转换在尝试时可能会失败（例如，将浮点数值转换为超出其范围的整数）。

registerConverter() 函数可用于注册其他转换，可以是内置类型与非内置类型之间的转换，也可以是两个非内置类型之间的转换。如果转换路径已注册，该函数将返回true 。

Qt 支持以下转换：

其他支持的转换包括所有基元类型（int,float,bool 等，包括所有枚举）之间的转换，以及任何指针类型和std::nullptr_t 之间的转换。枚举也可以转换为QString 和QByteArray 。

如果fromType 和toType 都是从QObject 派生的类型（或指向它们的指针），那么如果其中一个类型是从另一个派生的，则此函数也将返回true 。也就是说，如果static_cast<> 可以从fromType 描述的类型编译到toType 描述的类型，则返回 true。convert() 函数的操作类似于qobject_cast() ，它验证QVariant 所指向对象的动态类型。

如果toType 是QVariantList ，则从顺序容器进行的转置也会返回 true。

同样，如果toType 是QVariantHash 或QVariantMap ，则从关联容器进行的转置也会为该函数返回 true。

另请参见 convert(),QSequentialIterable,Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE(),QAssociativeIterable, 和Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE().

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

如果QMetaType::view 可以在fromType 上创建toType 类型的可变视图，则返回true 。

在QObject 派生类型的指针之间进行转换时，如果从fromType 所描述的类型到toType 所描述的类型的qobject_cast 转换成功，则此函数将返回 true。

您可以在任何通过Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE() 注册的容器上创建QSequentialIterable 类型的可变视图。

同样，您也可以在任何以Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE() 注册的容器上创建QAssociativeIterable 类型的可变视图。

另请参阅 convert(),QSequentialIterable,Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE(),QAssociativeIterable 和Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE().

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

比较lhs 和rhs 中的对象是否排序。

如果不支持比较或值未排序，则返回QPartialOrdering::Unordered 。否则，如果lhs 小于、等于或大于rhs ，则分别返回QPartialOrdering::Less 、QPartialOrdering::Equivalent 或QPartialOrdering::Greater 。

两个对象都必须是本元类型所描述的类型。如果lhs 或rhs 是nullptr ，则值是无序的。只有在元类型声明中可见类型的小于操作符时，才支持比较。

如果该类型的相等运算符也是可见的，那么只有当相等运算符表示值相等时，才会比较它们是否相等。在没有相等运算符的情况下，当两个值都不小于另一个值时，值被认为是相等的；如果也有相等运算符，但两个值不相等，它们被认为是无序的，就像浮点类型的 NaN（非数字）值不在其排序范围内一样。

此功能在 Qt 6.0 中引入。

另请参阅 equals() 和isOrdered()。

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

在where 所寻址的现有内存中构造一个与QMetaType 实例类型相同的值，该值是copy 的副本，并返回where 。如果copy 为零，则默认构造值。

这是一个低级函数，用于明确管理用于存储该类型的内存。如果不需要这种级别的控制，可以考虑调用create() （也就是说，使用 "new "而不是 "placement new"）。

必须确保where 指向可以存储新值的位置，并且where 适当对齐。类型的大小可以通过调用sizeOf() 查询。

对齐的经验法则是，除非对齐方式大于平台的最大有效对齐方式，否则类型应按其自然边界对齐，即大于类型的 2 的最小幂次对齐。在实际应用中，只有特殊硬件指令（例如 x86 上对齐的 SSE 加载和存储）才需要大于 2 * sizeof(void*) 的对齐方式。

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

将from 中的对象从fromType 转换到to 类型toType 中的预分配空间。如果转换成功，则返回true ，否则返回 false。

from 和to 都必须是有效的指针。

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

返回copy 的副本，假定它与此QMetaType 实例的创建类型相同。如果copy 是nullptr ，则会创建一个默认构造的实例。

另请参阅 QMetaType::destroy()。

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

将rhs 中的对象串流到调试流dbg 。成功时返回true ，否则返回 false。

void QMetaType::destroy(void *data) const

销毁data ，前提是该QMetaType 实例是为此类型创建的。

另请参阅 QMetaType::create().

void QMetaType::destruct(void *data) const

析构位于data 的值，假定该值属于构建QMetaType 实例的类型。

与destroy() 不同，该函数只调用类型的析构函数，而不调用删除操作符。

另请参见 QMetaType::construct()。

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

比较lhs 和rhs 中的对象是否相等。

两个对象必须都属于该元类型所描述的类型。只有在元类型声明中可见该类型的小于或相等运算符时，才能比较两个对象。否则，元类型永远不会认为两个值相等。如果在元类型声明中可见相等运算符，则该运算符具有权威性；否则，如果可见小于运算符，当两个值都不小于另一个值时，这两个值被视为相等。如果值是无序的（详见compare() ），它们就不相等。

如果两个对象比较后相等，则返回 true，否则返回 false。

此函数在 Qt 6.0 中引入。

另请参阅 isEqualityComparable() 和compare()。

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

返回构建QMetaType 实例的类型标志。要检查特定的类型特征，最好使用 "is-"函数而不是直接使用 flags。

另请参阅 QMetaType::TypeFlags, QMetaType::flags(),isDefaultConstructible(),isCopyConstructible(),isMoveConstructible(),isDestructible(),isEqualityComparable(), 和isOrdered().

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

返回与typeName 匹配的QMetaType 。如果类型名称不为QMetaType

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

返回与模板参数中的类型相对应的QMetaType 。

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

返回true ，如果元类型系统已注册从元类型 idfromType 到toType

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

如果元类型系统已注册从类型 From 到类型 To 的转换，则返回true 。

这是一个重载函数。

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

如果元类型系统为该元类型注册了数据流操作符，则返回true 。

此函数在 Qt 6.1 中引入。

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

如果元类型系统为该元类型注册了调试流操作符，则返回true 。

此函数在 Qt 6.0 中引入。

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

如果元类型系统在元类型 idfromType 的元类型 idtoType 上注册了可变视图，则返回true 。

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

如果元类型系统对 To 类型的 From 类型注册了可变视图，则返回true 。

这是一个重载函数。

此函数在 Qt 6.0 中引入。

int QMetaType::id() const

返回此 QMetatype 实例持有的 id 类型。

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

如果该类型可以复制构造，则返回 true。如果可以，则construct() 和create() 可以与非空的copy 参数一起使用。

此函数在 Qt 6.5 中引入。

另请参阅 flags()、isDefaultConstructible()、isMoveConstructible() 和isDestructible()。

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

如果该类型可以默认构造，则返回 true。如果可以，则construct() 和create() 可以与空的copy 参数一起使用。

此函数在 Qt 6.5 中引入。

另请参阅 flags()、isCopyConstructible()、isMoveConstructible() 和isDestructible()。

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

如果该类型可以被销毁，则返回 true。如果可以，则可以调用destroy() 和destruct() 。

此函数在 Qt 6.5 中引入。

另请参阅 flags()、isDefaultConstructible()、isCopyConstructible() 和isMoveConstructible()。

bool QMetaType::isEqualityComparable() const

如果元类型声明中可见该元类型所描述类型的小于或相等运算符，则返回true ，否则返回false 。

另请参见 equals() 和isOrdered()。

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

如果此类型可以被移动构造，则返回 true。QMetaType 目前没有使用此特性的 API。

此函数在 Qt 6.5 中引入。

另请参阅 flags()、isDefaultConstructible()、isCopyConstructible() 和isDestructible()。

bool QMetaType::isOrdered() const

如果元类型声明中可见该元类型描述的类型的小于运算符，则返回true ，否则返回false 。

另请参见 compare() 和isEqualityComparable()。

[noexcept] bool QMetaType::isRegistered() const

如果此QMetaType 对象已在 Qt XML 全局元类型注册表中注册，则返回true 。注册后，可通过名称（使用QMetaType::fromName()) 或 ID（使用构造函数）找到该类型。

另请参阅 qRegisterMetaType() 和isValid()。

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

如果 ID 为type 的数据类型已注册，则返回true ；否则返回false 。

另请参阅 type(),typeName() 和Type 。

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

如果QMetaType 对象包含有关类型的有效信息，则返回true ，否则返回 false。

另请参见 isRegistered().

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

将此类型的对象从给定的stream 读入data 。如果对象加载成功，则返回true ；否则返回false 。

通常情况下，您不需要直接调用此函数。取而代之的是使用QVariant 的operator>>() ，它依赖 load() 来流式传输自定义类型。

另请参阅 save() 。

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

返回相对于该类型的QMetaObject 。

如果该类型是指向QObject 子类的指针类型，则flags() 包含QMetaType::PointerToQObject ，该函数返回相应的QMetaObject 。该函数可与QMetaObject::newInstance() 结合使用，以创建该类型的 QObject。

如果类型是Q_GADGET ，则flags() 包含QMetaType::IsGadget 。如果类型是指向Q_GADGET 的指针，则flags() 包含QMetaType::PointerToGadget 。在这两种情况下，该函数都会返回其QMetaObject 。这可用于检索QMetaMethod 和QMetaProperty ，并将它们用于该类型的指针，如QVariant::data() 所示。

如果类型是枚举，flags() 包含QMetaType::IsEnumeration 。在这种情况下，如果枚举被注册为Q_ENUM ，则该函数返回外层对象的QMetaObject ，否则返回nullptr 。

另请参见 QMetaType::flags()。

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

返回与QMetaType 相关联的类型名称，如果没有找到匹配的类型，则返回一个空指针。返回的指针不得删除。

另请参阅 typeName()。

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

在元类型系统中注册从类型 From 到类型 To 的隐式转换可能性。如果注册成功，则返回true ，否则返回 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)

这是一个重载函数。

将function 类似 To From::function() const 的方法注册为元类型系统中从 From 类型到 To 类型的转换器。如果注册成功，则返回true ，否则返回 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)

这是一个重载函数。

将function 类似 To From::function(bool *ok) const 的方法注册为元类型系统中从 From 类型到 To 类型的转换器。如果注册成功，则返回true ，否则返回 false。

函数可以使用ok 指针来指示转换是否成功。

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)

这是一个重载函数。

在元类型系统中将单值函数对象function 注册为从 From 类型到 To 类型的转换器。如果注册成功，则返回true ，否则返回 false。

function 必须接收 类型的实例，并返回 类型的实例。它可以是函数指针、lambda 或函数对象。自 Qt XML 6.5 起， 也可以返回 的实例，以便能够指示失败的转换。From To function std::optional<To>

QMetaType::registerConverter<CustomStringType, QString>([](const CustomStringType &str) {
    return QString::fromUtf8(str.data());
});
QMetaType::registerConverter<QJsonValue, QPointF>(
          [](const QJsonValue &value) -> std::optional<QPointF> {
    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 QPointF{object["x"].toDouble(), object["y"].toDouble()};
});

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

这是一个重载函数。

将类似To From::function() 的方法function 注册为元类型系统中From 类型上To 类型的可变视图。如果注册成功，则返回true ，否则返回false 。

此函数在 Qt 6.0 中引入。

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

这是一个重载函数。

在元类型系统中将单值函数对象function 注册为 To 类型的可变视图。如果注册成功，则返回true ，否则返回false 。

此函数在 Qt 6.0 中引入。

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

使用QMetaType::fromName() 在类型注册表中注册QMetaType ，以便可以通过名称找到它。

该函数在 Qt 6.5 中引入。

另请参见 qRegisterMetaType()。

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

将data 指向的对象写入给定的stream 。如果对象保存成功，则返回true ；否则返回false 。

通常情况下，您不需要直接调用此函数。取而代之的是使用QVariant 的operator<<() ，它依赖 save() 来对自定义类型进行流式处理。

另请参阅 load() 。

[constexpr] qsizetype QMetaType::sizeOf() const

以字节为单位返回类型的大小（即 sizeof(T)，其中 T 是构建QMetaType 实例的实际类型）。

该函数通常与construct() 一起使用，对类型使用的内存进行底层管理。

另请参见 QMetaType::construct()、QMetaType::sizeOf() 和QMetaType::alignOf()。

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

如果该元类型代表一个枚举，则该方法返回一个数字类的元类型，其符号性和大小与枚举底层类型相同。如果表示QFlags 类型，则返回QMetaType::Int 。在所有其他情况下，将返回一个无效的QMetaType 。

此函数在 Qt 6.6 中引入。

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

在to 类型为toType 的预分配空间中创建from 的fromType 对象的可变视图。如果转换成功，则返回true ，否则返回 false。

此函数在 Qt 6.0 中引入。