Класс QMetaType

Класс QMetaType управляет именованными типами в системе метаобъектов. Подробнее...

• Список всех членов, включая унаследованные
• Устаревшие члены

Примечание: Все функции в этом классе являются потокобезопасными.

Открытые типы

Открытые функции

Статические публичные члены

Связанные нечлены

Макросы

Подробное описание

Класс используется в качестве помощника для маршаллирования типов в QVariant и в подключенных к очереди сигналах и слотах. Он связывает имя типа с типом, чтобы его можно было создавать и уничтожать динамически во время выполнения. Объявляйте новые типы с помощью Q_DECLARE_METATYPE(), чтобы сделать их доступными для QVariant и других функций на основе шаблонов. Вызывайте qRegisterMetaType(), чтобы сделать типы доступными для функций, не основанных на шаблонах, таких как подключения сигналов и слотов к очереди.

Любой класс или структура, имеющий публичный конструктор по умолчанию, публичный конструктор копирования и публичный деструктор, может быть зарегистрирован.

Следующий код выделяет и уничтожает экземпляр MyClass:

int id = QMetaType::type("MyClass");
if (id != QMetaType::UnknownType) {
    void *myClassPtr = QMetaType::create(id);
    ...
    QMetaType::destroy(id, myClassPtr);
    myClassPtr = 0;
}

Если мы хотим, чтобы операторы потоков operator<<() и operator>>() работали с объектами QVariant, хранящими пользовательские типы, пользовательский тип должен предоставлять операторы operator<<() и operator>>().

См. также Q_DECLARE_METATYPE(), QVariant::setValue(), QVariant::value() и QVariant::fromValue().

Документация по типам членов

enum QMetaType::Type

Вот встроенные типы, поддерживаемые QMetaType:

Дополнительные типы можно зарегистрировать, используя Q_DECLARE_METATYPE().

См. такжеtype() и typeName().

enum QMetaType::TypeFlagflags QMetaType::TypeFlags

Перечисление описывает атрибуты типа, поддерживаемые QMetaType.

Тип TypeFlags — это псевдоним для QFlags<TypeFlag>. Он хранит объединение значений TypeFlag.

Документация функций-членов

[since 5.0] QMetaType::QMetaType(int typeId)

Создает объект QMetaType, содержащий всю информацию о типе typeId.

Эта функция была введена в Qt 5.0.

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

Возвращает true, если QMetaType::convert может выполнить преобразование из fromType в toType.

Qt поддерживает следующие преобразования:

Поддержка приведения между примитивными типами (int, float, bool и т. д.).

Преобразование между указателями на типы, производные от QObject, также вернёт true для этой функции, если qobject_cast из типа, описанного fromType, в тип, описанный toType, был бы успешным.

Приведение из последовательного контейнера также вернёт true для этой функции, если toType — QVariantList.

Аналогично, приведение из ассоциативного контейнера также вернёт true для этой функции, если toType — QVariantHash или QVariantMap.

См. также convert(), QSequentialIterable, Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE(), QAssociativeIterable и Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE().

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

Возвращает true если QMetaType::view может создать изменяемый вид типа toType на типе fromType.

Преобразование между указателями на типы, производные от QObject, вернёт true для этой функции, если qobject_cast из типа, описанного fromType, в тип, описанный toType, был бы успешным.

Вы можете создать изменяемый вид типа QSequentialIterable для любого контейнера, зарегистрированного с помощью Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE().

Аналогично, вы можете создать изменяемый вид типа QAssociativeIterable для любого контейнера, зарегистрированного с помощью Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE().

См. также 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, если сравнение не поддерживается или значения не упорядочены. В противном случае возвращает QPartialOrdering::Less, QPartialOrdering::Equivalent или QPartialOrdering::Greater, если lhs меньше, эквивалентно или больше rhs соответственно.

Оба объекта должны быть того типа, который описывается этим метатипом. Если lhs или rhs — nullptr, значения не упорядочены. Сравнение поддерживается только если оператор "меньше чем" для типа был доступен для объявления метатипа.

Если оператор равенства для типа также был доступен, значения будут равны только если оператор равенства укажет на это. В отсутствие оператора равенства, когда ни одно значение не меньше другого, значения считаются равными; если равенство также доступно и два таких значения не равны, они считаются неупорядоченными, так же как значения NaN (не число) для плавающего типа находятся вне его упорядочения.

Примечание: Если оператор "меньше чем" не был доступен для объявления метатипа, значения неупорядочены, даже если оператор равенства, доступный для объявления, считает их равными: compare() == 0 согласуется с equals() только если оператор "меньше чем" был доступен.

Функция была введена в Qt 6.0.

См. также equals() и isOrdered().

[since 5.0] void *QMetaType::construct(void *where, const void *copy = nullptr) const

Создаёт значение типа, для которого был создан экземпляр QMetaType, в существующей памяти по адресу where, являющееся копией copy, и возвращает where. Если copy равно нулю, значение создаётся по умолчанию.

Это функция низкого уровня для явного управления памятью, используемой для хранения типа. Рассмотрите возможность вызова create(), если вам не нужен такой контроль (то есть, используйте "new" вместо "placement new").

Вы должны убедиться, что where указывает на место, где можно сохранить новое значение, и что where правильно выровнен. Размер типа можно запросить, вызвав sizeOf().

Правило для выравнивания заключается в том, что тип выравнивается по своей естественной границе, которая является наименьшей степенью двойки, большей, чем тип, за исключением случаев, когда это выравнивание больше максимального полезного выравнивания для платформы. Для практических целей выравнивание, большее, чем 2 * sizeof(void*), необходимо только для специальных инструкций аппаратного обеспечения (например, выровненных загрузок и сохранений SSE на x86).

Эта функция была добавлена в Qt 5.0.

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

Преобразует объект в from из fromType в предварительно выделенное пространство в to типа toType. Возвращает true, если преобразование выполнено успешно, в противном случае false.

Эта функция была добавлена в Qt 5.2.

[since 5.0] void *QMetaType::create(const void *copy = nullptr) const

Возвращает копию copy, предполагая, что она имеет тип, для которого был создан этот экземпляр QMetaType. Если copy равно nullptr, создаёт экземпляр, сконструированный по умолчанию.

Эта функция была добавлена в Qt 5.0.

См. также QMetaType::destroy().

[since 5.2] bool QMetaType::debugStream(QDebug &dbg, const void *rhs)

Выводит объект по адресу rhs в поток отладки dbg. Возвращает true при успехе, в противном случае false.

Эта функция была добавлена в Qt 5.2.

[since 5.0] void QMetaType::destroy(void *data) const

Уничтожает data, предполагая, что оно имеет тип, для которого был создан этот экземпляр QMetaType.

Эта функция была добавлена в Qt 5.0.

См. также QMetaType::create().

[since 5.0] void QMetaType::destruct(void *data) const

Уничтожает значение, расположенное по адресу data, предполагая, что оно имеет тип, для которого был создан этот экземпляр QMetaType.

В отличие от destroy(), эта функция вызывает только деструктор типа, она не вызывает оператор delete.

Эта функция была добавлена в Qt 5.0.

См. также 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().

[since 5.0] QMetaType::TypeFlags QMetaType::flags() const

Возвращает флаги типа, для которого был создан этот экземпляр QMetaType.

Эта функция была добавлена в Qt 5.0.

См. также QMetaType::TypeFlags и QMetaType::flags().

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

Возвращает QMetaType, соответствующий typeName. Возвращаемый объект недействителен, если имя типа не известно QMetaType.

[static, since 5.15] template <typename T> QMetaType QMetaType::fromType()

Возвращает QMetaType, соответствующий типу в параметре шаблона.

Эта функция была добавлена в Qt 5.15.

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

Возвращает true, если система метаданных имеет зарегистрированное преобразование от метатипа fromType к toType.

Эта функция была добавлена в Qt 5.2.

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

Возвращает true, если система метаданных имеет зарегистрированное преобразование от типа From к типу To.

Это перегруженная функция.

Эта функция была добавлена в Qt 5.2.

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

Возвращает true, если система метаданных имеет зарегистрированный оператор потока отладки для этого метатипа.

Эта функция была добавлена в Qt 6.0.

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

Возвращает true, если система метаданных имеет зарегистрированную изменяемую версию метатипа fromType метатипа toType.

Эта функция была добавлена в Qt 5.2.

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

Возвращает true, если система метаданных имеет зарегистрированную изменяемую версию типа From типа To.

Это перегруженная функция.

Эта функция была добавлена в Qt 6.0.

[since 5.13] int QMetaType::id() const

Возвращает идентификатор типа, хранимый этим экземпляром QMetatype.

Эта функция была добавлена в Qt 5.13.

bool QMetaType::isEqualityComparable() const

Возвращает true если для типа, описываемого этим метатипом, был доступен оператор меньше или равен в декларации метатипа, в противном случае false.

См. также equals() и isOrdered().

bool QMetaType::isOrdered() const

Возвращает true если для типа, описываемого этим метатипом, был доступен оператор меньше в декларации метатипа, в противном случае false.

См. также compare() и isEqualityComparable().

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

Возвращает true если тип данных с ID type зарегистрирован; в противном случае возвращает false.

См. также type(), typeName() и Type.

[since 5.0] bool QMetaType::isRegistered() const

Возвращает true если этот объект QMetaType содержит действительную информацию о типе, в противном случае false.

Эта функция была добавлена в Qt 5.0.

[since 5.0] bool QMetaType::isValid() const

Возвращает true если этот объект QMetaType содержит действительную информацию о типе, в противном случае false.

Эта функция была добавлена в Qt 5.0.

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

Читает объект этого типа из данного потока stream в data. Возвращает true если объект загружен успешно; в противном случае возвращает false.

Тип должен быть зарегистрирован с помощью Q_DECLARE_METATYPE() предварительно.

Обычно вам не нужно вызывать эту функцию напрямую. Вместо этого используйте operator>>() QVariant, который полагается на load() для потокового ввода пользовательских типов.

См. также save().

[since 5.5] const QMetaObject *QMetaType::metaObject() const

Возвращает QMetaObject, относящийся к этому типу.

Если тип — указатель на подкласс QObject, flags() содержит QMetaType::PointerToQObject, и эта функция возвращает соответствующий QMetaObject. Это можно использовать в сочетании с QMetaObject::construct для создания QObject данного типа.

Если тип является Q_GADGET, flags() содержит QMetaType::IsGadget, и эта функция возвращает его QMetaObject. Это можно использовать для получения QMetaMethod и QMetaProperty и их применения к указателю на этот тип. (например, с помощью QVariant::data)

Если тип — перечисление, flags() содержит QMetaType::IsEnumeration, и эта функция возвращает QMetaObject содержащего объекта, если перечисление было зарегистрировано как Q_ENUM, или nullptr в противном случае

Эта функция была добавлена в Qt 5.5.

См. также QMetaType::flags().

[since 5.15] const char *QMetaType::name() const

Возвращает имя типа, связанное с данным QMetaType, или нулевой указатель, если соответствующий тип не найден. Возвращаемый указатель не следует удалять.

Эта функция была добавлена в Qt 5.15.

См. также typeName().

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

Регистрирует возможность неявного преобразования из типа From в тип To в системе метатипов. Возвращает true если регистрация прошла успешно, в противном случае false.

Эта функция была добавлена в Qt 5.2.

[static, since 5.2] template <typename MemberFunction, int> bool QMetaType::registerConverter(MemberFunction function)

Это перегруженная функция.

Регистрирует метод function, например, To From::function() const, как преобразователь из типа From в тип To в системе метатипов. Возвращает true если регистрация прошла успешно, в противном случае false.

Эта функция была добавлена в Qt 5.2.

[static, since 5.2] template <typename MemberFunctionOk, char> bool QMetaType::registerConverter(MemberFunctionOk function)

Это перегруженная функция.

Регистрирует метод function, например, To From::function(bool *ok) const, как преобразователь из типа From в тип To в системе метатипов. Возвращает true если регистрация прошла успешно, в противном случае false.

Эта функция была добавлена в Qt 5.2.

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

Это перегруженная функция.

Регистрирует объект унарной функции function как преобразователь из типа From в тип To в системе метатипов. Возвращает true если регистрация прошла успешно, в противном случае false.

Эта функция была добавлена в Qt 5.2.

[static, since 6.0] template <typename MemberFunction, int> bool QMetaType::registerMutableView(MemberFunction function)

Это перегруженная функция.

Регистрирует метод function, например, To From::function() как изменяемый вид типа To на тип From в системе метатипов. Возвращает true если регистрация прошла успешно, в противном случае false.

Эта функция была добавлена в Qt 6.0.

[static, since 6.0] template <typename MemberFunctionOk, char> bool QMetaType::registerMutableView(MemberFunctionOk function)

Это перегруженная функция.

Регистрирует метод function, например, To From::function(bool *ok) как изменяемый вид типа To на тип From в системе метатипов. Возвращает true если регистрация прошла успешно, в противном случае false.

Эта функция была добавлена в Qt 6.0.

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

Это перегруженная функция.

Регистрирует объект унарной функции function как изменяемый вид типа To на тип From в системе метатипов. Возвращает true если регистрация прошла успешно, в противном случае false.

Эта функция была добавлена в Qt 6.0.

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

Записывает объект, на который указывает data, в заданный stream. Возвращает true если объект сохранен успешно; в противном случае возвращает false.

Тип должен быть зарегистрирован с помощью Q_DECLARE_METATYPE() предварительно.

Обычно вы не должны вызывать эту функцию напрямую. Вместо этого используйте operator<<() QVariant, которые полагаются на save() для потоковой передачи пользовательских типов.

См. также load().

[since 5.0] qsizetype QMetaType::sizeOf() const

Возвращает размер типа в байтах (т. е. sizeof(T), где T — фактический тип, для которого был создан этот QMetaType).

Эта функция обычно используется вместе с construct() для низкоуровневого управления памятью, используемой типом.

Эта функция была добавлена в Qt 5.0.

См. также QMetaType::construct(), QMetaType::sizeOf() и QMetaType::alignOf().

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

Создаёт изменяемый вид на объект в from типа fromType в предварительно выделенном пространстве в to типа toType. Возвращает true если преобразование выполнено успешно, в противном случае false.

Эта функция была добавлена в Qt 6.0.

int id = qMetaTypeId<QString>();    // id is now QMetaType::QString
id = qMetaTypeId<MyStruct>();       // compile error if MyStruct not declared

qRegisterMetaType<MyClass>("MyClass");

typedef QString CustomString;
qRegisterMetaType<CustomString>("CustomString");

int id = qRegisterMetaType<MyStruct>();

#include <unordered_list>

Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE(std::unordered_map)

void someFunc()
{
    std::unordered_map<int, bool> container;
    QVariant var = QVariant::fromValue(container);
    // ...
}

struct MyStruct
{
    int i;
    ...
};

Q_DECLARE_METATYPE(MyStruct)

namespace MyNamespace
{
    ...
}

Q_DECLARE_METATYPE(MyNamespace::MyStruct)

MyStruct s;
QVariant var;
var.setValue(s); // copy s into the variant

...

// retrieve the value
MyStruct s2 = var.value<MyStruct>();

QDataStream &operator<<(QDataStream &out, const MyClass &myObj);
QDataStream &operator>>(QDataStream &in, MyClass &myObj);

#include <deque>

Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE(std::deque)

void someFunc()
{
    std::deque<QFile*> container;
    QVariant var = QVariant::fromValue(container);
    // ...
}

#include <memory>

Q_DECLARE_SMART_POINTER_METATYPE(std::shared_ptr)

void someFunc()
{
    auto smart_ptr = std::make_shared<QFile>();
    QVariant var = QVariant::fromValue(smart_ptr);
    // ...
    if (var.canConvert<QObject*>()) {
        QObject *sp = var.value<QObject*>();
        qDebug() << sp->metaObject()->className(); // Prints 'QFile'.
    }
}