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

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

[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 (не число) для типа с плавающей точкой лежат вне его порядка.

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

Оба указателя from и to должны быть валидными.

Функция была добавлена в 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. Возвращаемый объект недействителен, если 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.1] bool QMetaType::hasRegisteredDataStreamOperators() const

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

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

[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 , если тип данных с идентификатором 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() предварительно.

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

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

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

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

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