Класс 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().

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

перечисление QMetaType::Type

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

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

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

enum QMetaType::TypeFlagflags QMetaType::TypeFlags

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

Тип TypeFlags является типом-синонимом для QFlags<TypeFlag>. Он хранит логическое ИЛИ комбинацию значений TypeFlag.

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

QMetaType::QMetaType(const int typeId = QMetaType::UnknownType)

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

Примечание: Параметр по умолчанию был добавлен в Qt 5.15.

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

QMetaType::~QMetaType()

Деструктор этого объекта.

[static] bool QMetaType::compare(const void *lhs, const void *rhs, int typeId, int *result)

Сравнивает объекты в lhs и rhs. Оба объекта должны быть типа typeId. result устанавливается меньше, равно или больше нуля, если lhs меньше, равно или больше rhs. Возвращает true, если сравнение прошло успешно, иначе false.

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

[static] void *QMetaType::construct(int type, void *where, const void *copy)

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

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

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

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

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

См. также destruct() и sizeOf().

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

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

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

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

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

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

[static] bool QMetaType::convert(const void *from, int fromTypeId, void *to, int toTypeId)

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

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

[static] void *QMetaType::create(int type, const void *copy = nullptr)

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

См. также destroy(), isRegistered(), и Type.

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

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

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

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

[static] bool QMetaType::debugStream(QDebug &dbg, const void *rhs, int typeId)

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

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

[static] void QMetaType::destroy(int type, void *data)

Удаляет data, предполагая, что оно имеет тип type.

См. также create(), isRegistered(), и Type.

void QMetaType::destroy(void *data) const

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

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

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

[static] void QMetaType::destruct(int type, void *where)

Вызывает деструктор значения заданного типа type, находящегося по адресу where.

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

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

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

void QMetaType::destruct(void *data) const

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

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

Данная функция была представлена в Qt 5.0.

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

[static] bool QMetaType::equals(const void *lhs, const void *rhs, int typeId, int *result)

Сравнивает объекты по адресам lhs и rhs. Оба объекта должны иметь тип typeId. result устанавливается в ноль, если lhs равен rhs. Возвращает true, если сравнение прошло успешно, иначе false.

Данная функция была представлена в Qt 5.5.

QMetaType::TypeFlags QMetaType::flags() const

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

Данная функция была представлена в Qt 5.0.

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

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

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

Данная функция была представлена в Qt 5.15.

[static] template <typename T> bool QMetaType::hasRegisteredComparators()

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

Данная функция была представлена в Qt 5.2.

[static] bool QMetaType::hasRegisteredComparators(int typeId)

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

Данная функция была представлена в Qt 5.2.

[static] bool QMetaType::hasRegisteredConverterFunction(int fromTypeId, int toTypeId)

Возвращает true, если система метатипов зарегистрировала преобразование из метатипа с идентификатором fromTypeId в toTypeId.

Данная функция была представлена в Qt 5.2.

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

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

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

Данная функция была представлена в Qt 5.2.

[static] template <typename T> bool QMetaType::hasRegisteredDebugStreamOperator()

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

Данная функция была представлена в Qt 5.2.

[static] bool QMetaType::hasRegisteredDebugStreamOperator(int typeId)

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

Данная функция была представлена в Qt 5.2.

int QMetaType::id() const

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

Данная функция была представлена в Qt 5.13.

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

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

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

bool QMetaType::isRegistered() const

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

Данная функция была представлена в Qt 5.0.

bool QMetaType::isValid() const

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

Данная функция была представлена в Qt 5.0.

[static] bool QMetaType::load(QDataStream &stream, int type, void *data)

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

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

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

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

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::metaObjectForType() и QMetaType::flags().

[static] const QMetaObject *QMetaType::metaObjectForType(int type)

Возвращает QMetaType::metaObject для type.

Данная функция была представлена в Qt 5.0.

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

::QByteArray QMetaType::name() const

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

Данная функция была представлена в Qt 5.15.

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

[static] template <typename T> bool QMetaType::registerComparators()

Регистрирует операторы сравнения для зарегистрированного пользователем типа T. Требуется, чтобы у типа T были перегружены операторы == и <. Возвращает true если регистрация прошла успешно, иначе false.

Данная функция была представлена в Qt 5.2.

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

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

Данная функция была представлена в Qt 5.2.

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

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

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

Данная функция была представлена в Qt 5.2.

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

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

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

Данная функция была представлена в Qt 5.2.

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

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

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

Данная функция была представлена в Qt 5.2.

[static] template <typename T> bool QMetaType::registerDebugStreamOperator()

Регистрирует оператор вывода в поток для отладки для зарегистрированного пользователем типа T. Требуется, чтобы у типа T был оператор <<(QDebug dbg, T). Возвращает true если регистрация прошла успешно, иначе false.

[static] шаблон <typename T> bool QMetaType::registerEqualsComparator()

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

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

[static] bool QMetaType::save(QDataStream &stream, int type, const void *data)

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

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

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

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

[static] int QMetaType::sizeOf(int type)

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

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

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

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

int QMetaType::sizeOf() const

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

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

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

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

[static] int QMetaType::type(const char *typeName)

Возвращает дескриптор типа, называемого typeName, или QMetaType::UnknownType, если такого типа нет.

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

[static] int QMetaType::type(const ::QByteArray &typeName)

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

Возвращает дескриптор типа, называемого typeName, или 0, если такого типа нет.

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

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

[static] QMetaType::TypeFlags QMetaType::typeFlags(int type)

Возвращает флаги данного type.

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

См. также QMetaType::TypeFlags.

[static] const char *QMetaType::typeName(int typeId)

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

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

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

qRegisterMetaTypeStreamOperators<MyClass>("MyClass");

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

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

#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'.
    }
}