Класс QMetaType

Класс 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, который содержит всю информацию о типе typeId.

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

QMetaType::~QMetaType()

Удаляет этот объект.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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] 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] bool QMetaType::hasRegisteredConverterFunction()

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

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

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

[static] bool QMetaType::hasRegisteredDebugStreamOperator()

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

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

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

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

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

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

Возвращает true, если тип данных с идентификатором 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, иначе 0.

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

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

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

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

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

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

[static] bool QMetaType::registerComparators()

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

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

[static] bool QMetaType::registerConverter()

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

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

[static] bool QMetaType::registerConverter(MemberFunction function)

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

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

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

[static] bool QMetaType::registerConverter(MemberFunctionOk function)

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

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

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

[static] bool QMetaType::registerConverter(UnaryFunction function)

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

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

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

[static] bool QMetaType::registerDebugStreamOperator()

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

[static] 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() предварительно.

Как правило, вам не нужно вызывать эту функцию напрямую. Вместо этого используйте operator<<() объекта QVariant, который полагается на 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.

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