QMetaType 类

成员函数文档

[显式] QMetaType::QMetaType(int typeId)

构建一个 QMetaType 对象，该对象包含有关类型 typeId 的所有信息。

[常量表达式 exception-safe, 自 6.0 版起] QMetaType::QMetaType()

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

此函数是在 Qt 6.0 版本中引入的。

[常量表达式, 自 6.0 版起] qsizetype QMetaType::alignOf() const

返回类型的字节对齐（即 alignof(T)，其中 T 是为此 QMetaType 实例构建的实际类型）。

此函数通常与 construct() 一起使用，以执行类型使用的内存的低级管理。

此函数是在 Qt 6.0 版本中引入的。

另请参阅QMetaType::construct() 以及 QMetaType::sizeOf。

[静态] bool QMetaType::canConvert(QMetaType fromType, QMetaType toType)

如果 QMetaType::convert 可以从 fromType 转换到 toType，则返回 true。

Qt 支持以下转换

支持基本类型（int、float、bool等）之间的转换。

如果从QObject派生的类型之间的指针转换会成功，则此函数对于QMetaType中的转换也将返回真。

如果toType是QVariantList，则从顺序容器到其的转换也将返回真。

类似地，如果从关联容器到其的转换会成功，则从关联容器到QVariantHash或QVariantMap的转换也会返回真。

另请参阅convert()、QSequentialIterable、Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE()、QAssociativeIterable和Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE。

[静态] bool QMetaType::canView(QMetaType fromType, QMetaType toType)

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

如果从类型fromType到类型toType的qobject_cast会成功，则此函数对于从QObject派生的类型的指针转换也将返回真。

您可以在使用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 是零，则值是默认构造的。

这是一个用于显式管理存储类型的内存的低级函数。如果不需要此级别的控制（即使用 "new" 而不是 "placement new"），请考虑调用 create()。

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

对齐的规则是一个类型对齐到其自然边界，即比类型大的最小的 2 的幂，除非这种对齐大于平台的最大有用对齐。为了实用目的，大于 2 * sizeof(void*) 的对齐仅在特殊的硬件指令（例如，x86 上的对齐 SSE 加载和存储）下是必要的。

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

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

“从” 和 “到” 都必须是有效的指针。

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-”函数之一，而不要直接使用标志。

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

[静态] QMetaType QMetaType::fromName(QByteArrayView typeName)

返回与 typeName 匹配的 QMetaType。如果 QMetaType 未知 typeName，返回对象无效。

[静态常量模板] template <typename T> QMetaType QMetaType::fromType()

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

[静态] bool QMetaType::hasRegisteredConverterFunction(QMetaType fromType, QMetaType toType)

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

[静态模板] template <typename From, typename To> bool QMetaType::hasRegisteredConverterFunction()

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

这是重载函数。

[自 6.1 版起] bool QMetaType::hasRegisteredDataStreamOperators() const

如果元类型系统已为该元类型注册数据流运算符，则返回 true。

此函数自 Qt 6.1 版本开始引入。

[自 6.0 版起] bool QMetaType::hasRegisteredDebugStreamOperator() const

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

此函数是在 Qt 6.0 版本中引入的。

[静态] bool QMetaType::hasRegisteredMutableViewFunction(QMetaType fromType, QMetaType toType)

如果元类型系统已注册在元类型id fromType 上对元类型id toType 的可变视图，则返回 true。

[静态，自 6.0 版起] template <typename From, typename To> bool QMetaType::hasRegisteredMutableViewFunction()

如果元类型系统已注册在类型 To 中的类型 From 上的可变视图，则返回 true。

这是重载函数。

此函数是在 Qt 6.0 版本中引入的。

int QMetaType::id() const

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

[不可抛出异常，自 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。如果可以，则可以使用一个值为 null 的 copy 参数调用 construct() 和 create()。

此函数自 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。

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

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

另请参阅type、typeName 和 Type。

bool QMetaType::isRegistered() const

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

另请参阅qRegisterMetaType 和 isValid。

bool QMetaType::isValid() const

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

另请参阅isRegistered。

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

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

通常，您不需要直接调用此函数。相反，使用QVariant的运算符>>()，它依赖于load()来流处理自定义类型。

另请参阅save。

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

返回与此类型相关的QMetaObject。

如果类型是指向QObject子类的指针类型，则flags()包含QMetaType::PointerToQObject，并且此函数返回相应的QMetaObject。这可以与QMetaObject::newInstance()一起使用来创建此类型的QObjects。

如果类型是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] 模板 <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] 模板 <typename From, typename To> bool QMetaType::registerConverter(To (From::*)() const function)

这是重载函数。

在元类型系统中注册类似于 To From::function() const 的方法 function 作为类型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] 模板 <typename From, typename To> bool QMetaType::registerConverter(To (From::*)(bool *) const function)

这是重载函数。

在元类型系统中注册像 To From::function(bool *ok) const 一样的 function 方法作为从类型 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] 模板 <typename From, typename To, typename UnaryFunction> bool QMetaType::registerConverter(UnaryFunction function)[a class="plink" href="#registerConverter-3" title="直接链接到此标题"]

这是重载函数。

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

function 必须接受一个类型为 From 的实例，并返回一个类型为 To 的实例。它可以是一个函数指针、lambda 表达式或对象。自 Qt 6.5 起支持返回 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] 模板 <typename From, typename To> bool QMetaType::registerMutableView(To (From::*)() function)[a class="plink" href="#registerMutableView" title="直接链接到此标题"]

这是重载函数。

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

此函数是在 Qt 6.0 版本中引入的。

[static, since 6.0] 模板 <typename From, typename To, typename UnaryFunction> bool QMetaType::registerMutableView(UnaryFunction function)[a class="plink" href="#registerMutableView-1" title="直接链接到此标题"]

这是重载函数。

在元类型系统中注册像 function 这样的单参数函数对象，作为类型 From 上类型 To 的可变视图。如果注册成功返回 true，否则返回 false。

此函数是在 Qt 6.0 版本中引入的。

[since 6.5] void QMetaType::registerType() const[a class="plink" href="#registerType" title="直接链接到此标题"]

注册此 QMetaType 至类型注册器，使其可以通过名称查找，使用 QMetaType::fromName。

此函数自 Qt 6.5 版本开始引入。

参阅 qRegisterMetaType。

bool QMetaType::save(QDataStream &stream, const void *data) const[a class="plink" href="#save" title="直接链接到此标题"]

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

通常情况下，您不需要直接调用此函数。相反，使用 QVariant 的 operator<<()，它依赖于该函数来序列化自定义类型。

参阅 load。

[constexpr] qsizetype QMetaType::sizeOf() const[a class="plink" href="#sizeOf-1" title="直接链接到此标题"]

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

此函数通常与 construct() 一起使用，以执行类型使用的内存的低级管理。

参阅 QMetaType::construct()，QMetaType::sizeOf() 和 QMetaType::alignOf。

[since 6.6] QMetaType QMetaType::underlyingType() const[a class="plink" href="#underlyingType" title="直接链接到此标题"]

如果此元类型表示枚举类型，则此方法返回与枚举基类型具有相同符号和大小值的数字类的元类型。如果它表示QFlags类型，则返回QMetaType::Int。在其他所有情况下返回无效的QMetaType。

此函数在Qt 6.6中引入。

[静态，自6.0起] bool QMetaType::view(QMetaType fromType, void *from, QMetaType toType, void *to)

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

此函数是在 Qt 6.0 版本中引入的。