QMetaType Class

メンバ関数のドキュメント

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

デフォルトの、無効な QMetaType オブジェクトを生成します。

この関数は Qt 6.0 で導入されました。

[explicit] QMetaType::QMetaType(int typeId)

型typeId に関するすべての情報を含むQMetaTypeオブジェクトを作成します。

[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() 関数を使用すると、組み込み型と非組み込み型の間の変換、あるいは2つの非組み込み型間の変換など、追加の変換を登録することができます。この関数は、変換パスが登録されている場合にtrue を返します。

Qtでは、以下の変換がサポートされています：

その他、サポートされている変換には、すべてのプリミティブ型間（int 、float 、bool など、すべての列挙型を含む）および任意のポインタ型とstd::nullptr_t 間の変換が含まれます。また、列挙型はQString およびQByteArray に変換することもできます。

fromType とtoType の両方がQObject から派生した型（またはそれらへのポインタ）である場合、一方の型が他方から派生しているときは、この関数はtrue を返します。つまり、fromType で記述された型からtoType で記述された型へのstatic_cast<> がコンパイル可能であれば、true を返します。convert() 関数はqobject_cast() と同様に動作し、QVariant が指すオブジェクトの動的型を検証します。

toType がQVariantList である場合、シーケンシャルコンテナからの型変換でも、この関数に対してtrueが返されます。

同様に、連想コンテナからのキャストも、toType がQVariantHash またはQVariantMap である場合、この関数に対してtrueを返します。

convert()、QMetaSequence::Iterable 、Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE()、QMetaAssociation::Iterable 、および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() に登録された任意のコンテナに対して、QMetaSequence::Iterable 型の可変ビューを作成することができます。

同様に、Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE() で登録された任意のコンテナに対して、QMetaAssociation::Iterable 型の可変ビューを作成できます。

convert()、QMetaSequence::Iterable 、Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE()、QMetaAssociation::Iterable 、および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 の場合、値は順序付けられていません。比較は、その型の「より小さい」演算子がメタタイプ宣言から可視であった場合にのみサポートされます。

その型の等価演算子も可視であった場合、値が等しいとみなされるのは、等価演算子がそう定めている場合に限られる。 等価演算子が存在しない場合、いずれの値も他方より小さくないときは、それらの値は等しいとみなされます。等価演算子が利用可能であり、そのような2つの値が等しくない場合、それらは順序付けられていないとみなされます。これは、浮動小数点型のNaN（Not a Number）値がその順序付けの範囲外にあるのと同じです。

この関数は Qt 6.0 で導入されました。

equals() およびisOrdered()も参照してください 。

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

where が指す既存のメモリ領域（copy のコピー）に、この `QMetaType ` インスタンスが構築された型に対応する値を構築し、where を返します。copy が 0 の場合、値はデフォルト構築されます。

これは、型を格納するために使用されるメモリを明示的に管理するための低レベルの関数です。このレベルの制御が必要ない場合は、create() の呼び出しを検討してください（つまり、「placement new」ではなく「new」を使用してください）。

where が新しい値を格納できる場所を指していること、およびwhere が適切にアラインメントされていることを確認する必要があります。型のサイズは、sizeOf()を呼び出すことで照会できます。

アライメントに関する経験則として、型はその「自然な境界」にアラインされる。これは、その型よりも大きい最小の2の冪であるが、そのアライメントがプラットフォームの最大有効アライメントよりも大きくなる場合はこの限りではない。 実用上、2 * sizeof(void*) を超えるアライメントが必要となるのは、特殊なハードウェア命令（例：x86 におけるアライメントされた SSE ロードおよびストア）の場合に限られます。

[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() とは異なり、この関数はその型のデストラクタのみを呼び出し、delete 演算子は呼び出しません。

QMetaType::construct()も参照してください 。

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

lhs およびrhs にあるオブジェクトを、等価性について比較します。

両方のオブジェクトは、このメタタイプで記述された型でなければなりません。その型に対する「より小さい」または「等しい」演算子がメタタイプ宣言から可視であった場合にのみ、2つのオブジェクトを比較できます。そうでない場合、メタタイプは決して値を等しいとは見なしません。 等価演算子がメタタイプ宣言から可視であった場合、その演算子が基準となります。そうでない場合、小なり演算子が可視であり、かつどちらの値も他方より小さくないときは、2つの値は等しいとみなされます。値が順序付けられていない場合（詳細についてはcompare() を参照）、それらは等しくありません。

2つのオブジェクトが等しい場合はtrueを返し、そうでない場合はfalseを返します。

この関数は Qt 6.0 で導入されました。

isEqualityComparable() およびcompare()も参照してください 。

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

このQMetaType インスタンスが構築された型のフラグを返します。特定の型の特性を確認するには、フラグを直接参照するのではなく、「is-」関数のいずれかを使用することをお勧めします。

関連項目: QMetaType::TypeFlags 、isDefaultConstructible()、isCopyConstructible()、isMoveConstructible()、isDestructible()、isEqualityComparable()、およびisOrdered()。

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

typeName に一致する `QMetaType ` を返します。`typeName` が ` ` に認識されていない場合、返されるオブジェクトは無効となります。QMetaType

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

テンプレートパラメータで指定された型に対応するQMetaType を返します。

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

メタ型システムに、メタ型 ID `fromType ` から `true` への変換が登録されている場合、` ` を返します。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)

メタ型システムに、メタ型 IDtoType を持つメタ型 IDfromType に対する可変ビューが登録されている場合、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() は、null ではないcopy パラメータとともに使用できます。

この関数は Qt 6.5 で導入されました。

flags()、isDefaultConstructible()、isMoveConstructible()、およびisDestructible()も参照してください 。

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

この型がデフォルトコンストラクタで生成可能であれば、trueを返します。生成可能な場合、construct() およびcreate() は、copy パラメータとして null を指定して使用できます。

この関数は 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 のグローバルメタタイプレジストリに登録されている場合、true を返します。登録を行うと、その型を名前（QMetaType::fromName() を使用）または ID（コンストラクタを使用）で検索できるようになります。

qRegisterMetaType() およびisValid()も参照してください 。

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

IDがtype のデータ型が登録されている場合はtrue を返し、そうでない場合はfalse を返します。

type() および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 に関連付けられた型名を返します。一致する型が見つからない場合は、nullポインタを返します。返されたポインタをdeleteしてはなりません。

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::*function)() const)

メタ型システムにおいて、型 From から型 To への変換子として、function のようなメソッド（To From::function() const）を登録します。登録に成功した場合は `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::*function)(bool *) const)

メタ型システムにおいて、型 From から型 To へのコンバータとして、function のようなメソッド（To From::function(bool *ok) const）を登録します。登録に成功した場合は `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 From 型のインスタンスを受け取り、 型のインスタンスを返す必要があります。関数ポインタ、ラムダ、またはファンクタオブジェクトのいずれでも構いません。Qt 6.5以降、 は変換の失敗を示すために、 型のインスタンスを返すことも可能になりました。To function std::optional<To>

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)())

メタ型システムにおいて、型 `From ` に対して、型 `To ` の可変ビューとして `To From::function() ` のようなメソッド `function ` を登録します。登録に成功した場合は `true ` を返し、失敗した場合は `false` を返します。

この関数は Qt 6.0 で導入されました。

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

単項関数オブジェクト `function ` を、メタ型システムにおいて型 `From` 上の型 `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::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)

from to にある 型の事前割り当て済み領域内の、 にあるオブジェクトに対する可変ビューを作成します。変換が成功した場合は を返し、そうでない場合は false を返します。toType fromType true

この関数は Qt 6.0 で導入されました。