Класс 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: Прочитайте документацию по QChar Прочитайте документацию по QChar

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

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

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

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

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

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

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

Правило для выравнивания состоит в том, что тип выравнивается до своего естественного предела, который является наименьшей степенью 2, большей, чем тип, за исключением случаев, когда это выравнивание больше максимального полезного выравнивания для платформы. Для практических целей выравнивание больше 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 = Q_NULLPTR)

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

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

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

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

Эта функция была добавлена в 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.

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, если тип данных с 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, иначе 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 с ID 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] TypeFlags QMetaType::typeFlags(int type)

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

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

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

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

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

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