Qregistermetatype как пользоваться qt
Перейти к содержимому

Qregistermetatype как пользоваться qt

  • автор:


Creating Custom Qt Types

When creating user interfaces with Qt, particularly those with specialized controls and features, developers sometimes need to create new data types that can be used alongside or in place of Qt’s existing set of value types.

Standard types such as QSize, QColor and QString can all be stored in QVariant objects, used as the types of properties in QObject-based classes, and emitted in signal-slot communication.

In this document, we take a custom type and describe how to integrate it into Qt’s object model so that it can be stored in the same way as standard Qt types. We then show how to register the custom type to allow it to be used in signals and slots connections.

Creating a Custom Type

Before we begin, we need to ensure that the custom type we are creating meets all the requirements imposed by QMetaType. In other words, it must provide:

  • a public default constructor,
  • a public copy constructor, and
  • a public destructor.

The following Message class definition includes these members:

The class also provides a constructor for normal use and two public member functions that are used to obtain the private data.

Declaring the Type with QMetaType

The Message class only needs a suitable implementation in order to be usable. However, Qt’s type system will not be able to understand how to store, retrieve and serialize instances of this class without some assistance. For example, we will be unable to store Message values in QVariant.

The class in Qt responsible for custom types is QMetaType. To make the type known to this class, we invoke the Q_DECLARE_METATYPE() macro on the class in the header file where it is defined:

This now makes it possible for Message values to be stored in QVariant objects and retrieved later. See the Custom Type Example for code that demonstrates this.

The Q_DECLARE_METATYPE() macro also makes it possible for these values to be used as arguments to signals, but only in direct signal-slot connections. To make the custom type generally usable with the signals and slots mechanism, we need to perform some extra work.

Creating and Destroying Custom Objects

Although the declaration in the previous section makes the type available for use in direct signal-slot connections, it cannot be used for queued signal-slot connections, such as those that are made between objects in different threads. This is because the meta-object system does not know how to handle creation and destruction of objects of the custom type at run-time.

To enable creation of objects at run-time, call the qRegisterMetaType() template function to register it with the meta-object system. This also makes the type available for queued signal-slot communication as long as you call it before you make the first connection that uses the type.

The Queued Custom Type Example declares a Block class which is registered in the main.cpp file:

This type is later used in a signal-slot connection in the window.cpp file:

If a type is used in a queued connection without being registered, a warning will be printed at the console; for example:

Making the Type Printable

It is often quite useful to make a custom type printable for debugging purposes, as in the following code:

This is achieved by creating a streaming operator for the type, which is often defined in the header file for that type:

The implementation for the Message type in the Custom Type Example goes to some effort to make the printable representation as readable as possible:

The output sent to the debug stream can, of course, be made as simple or as complicated as you like. Note that the value returned by this function is the QDebug object itself, though this is often obtained by calling the maybeSpace() member function of QDebug that pads out the stream with space characters to make it more readable.

Further Reading

The Q_DECLARE_METATYPE() macro and qRegisterMetaType() function documentation contain more detailed information about their uses and limitations.

The Custom Type and Queued Custom Type examples show how to implement a custom type with the features outlined in this document.

The Debugging Techniques document provides an overview of the debugging mechanisms discussed above.

© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.


The Q_DECLARE_METATYPE() makes the type known to all template based functions, including QVariant. But if we want to use the type in queued signal and slot connections or in QObject’s property system, you have to call qRegisterMetaType() since the names are resolved at runtime.


This macro is used to specialise the template class QMetaTypeId with typename TYPE, in which, a static member function qt_metatype_id() is defined.

qRegisterMetaType() is called to register the TYPE and generate a TYPE ID. Then the TYPE ID is saved in local static vairable metatype_id.

Note that, for Qt’s builtin types, Q_DECLARE_BUILTIN_METATYPE instead of Q_DECLARE_METATYPE is used. The ids of these types are constant.

Olivier Goffart said that, <% blockquote %>I beleive it has been added so adding builting type do not conflicts with Q_DECLARE_METATYPE of the same type.


Information of Qt’s builtin types is saved in a static global const struct array types[] .

While the information of the types register through qRegisterMetaType is stored in static QVector with type QCustomTypeInfo

The definition of QCustomTypeInfo:

qRegisterMetaType() vs qRegisterMetaType(const char *)

When Call qRegisterMetaType() to register the type T. T must be declared with Q_DECLARE_METATYPE() As the member function qt_metatype_id() which is expaned from Q_DECLARE_METATYPE will be called in qMetaTypeId ().

And we can see that, qRegisterMetaType(const char *) is called in qt_metatype_id() too.

Finally, QCustomTypeInfo will be constructed and added to the static QVector.


Создание пользовательских типов Qt

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

Стандартные типы, такие как QSize , QColor и QString, могут все храниться в объектах QVariant , использоваться в качестве типов свойств в классах, основанных на QObject , и передаваться при обмене данными между сигнальными слотами.

В этом документе мы берем пользовательский тип и описываем,как интегрировать его в объектную модель Qt так,чтобы он мог храниться так же,как стандартные типы Qt.Затем мы показываем,как регистрировать пользовательский тип,чтобы позволить использовать его в сигналах и соединениях слотов.

Создание пользовательского типа

Прежде чем мы начнем, нам нужно убедиться, что создаваемый нами настраиваемый тип соответствует всем требованиям, предъявляемым QMetaType . Другими словами, он должен обеспечивать:

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

Следующее определение класса Message включает эти члены:

Класс также предоставляет конструктор для нормального использования и две функции-членов public,которые используются для получения приватных данных.

Объявление типа с помощью QMetaType

Классу Message нужна только подходящая реализация, чтобы его можно было использовать. Однако система типов Qt не сможет понять, как хранить, извлекать и сериализовать экземпляры этого класса без некоторой помощи. Например, мы не сможем хранить значения Message в QVariant .

Класс в Qt, отвечающий за пользовательские типы, — QMetaType . Чтобы сделать тип известным этому классу, мы вызываем макрос Q_DECLARE_METATYPE () для класса в заголовочном файле, где он определен:

Теперь это позволяет сохранять значения Message в объектахQVariant и извлекать их позже. См. Пример пользовательского типа для кода, демонстрирующего это.

Макрос Q_DECLARE_METATYPE () также позволяет использовать эти значения в качестве аргументов сигналов, но только в прямых сигнально-слотовых соединениях . Чтобы пользовательский тип обычно можно было использовать с механизмом сигналов и слотов, нам нужно проделать некоторую дополнительную работу.

Создание и уничтожение пользовательских объектов

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

Чтобы разрешить создание объектов во время выполнения, вызовите функцию шаблона qRegisterMetaType (), чтобы зарегистрировать ее в системе метаобъектов. Это также делает тип доступным для связи с сигнальным слотом в очереди, пока вы вызываете его до того, как вы сделаете первое соединение, использующее этот тип.

Пример пользовательского типа с очередью объявляет класс Block , зарегистрированный в файле main.cpp :

Этот тип позже используется в соединении сигнального слота в файле window.cpp :

Если тип используется в очередном соединении без регистрации,то на консоли будет напечатано предупреждение,например:

Сделать тип печатающего устройства

Часто бывает достаточно полезно сделать пользовательский тип печатаемым для отладочных целей,как в следующем коде:

Это достигается путем создания потокового оператора для данного типа,который часто определяется в заголовочном файле для данного типа:

Реализация типа Message в Примере пользовательского типа прилагает некоторые усилия, чтобы сделать печатное представление как можно более читабельным:

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

Further Reading

Макрос Q_DECLARE_METATYPE ( ) и документация по функции qRegisterMetaType () содержат более подробную информацию об их использовании и ограничениях.

Примеры Custom Type и Queued Custom Type показывают, как реализовать пользовательский тип с функциями, описанными в этом документе.

В документе « Методы отладки» представлен обзор механизмов отладки, описанных выше.

Пользовательские типы в Qt по D-Bus

imageНа хабре были статьи о D-Bus в Qt (раз) и немного затронули пользовательские типы (два). Здесь будет рассмотрена реализация передачи пользовательских типов, связанные с ней особенности, обходные пути.
Статья будет иметь вид памятки, с небольшим вкраплением сниппетов, и для себя и для коллег.
Примечание: изучалось под Qt 4.7(Спасибо Squeeze за это. ), поэтому некоторые действия могут оказаться бесполезными.


Стандартные типы, для передачи которых не требуется лишних телодвижений есть в доке. Также реализована возможность передавать по D-Bus тип QVariant (QDBusVariant). Это позволяет передавать те типы, которые QVariant может принимать в конструкторе — от QRect до QVariantList и QVariantMap (двумерные массивы не работают как положено). Есть соблазн передавать свои типы преобразовывая их в QVariant. Лично я рекомендовал бы отказаться от такого способа, поскольку принимающая сторона не сможет различить несколько различных типов — все они будут для неё QVariant. На мой взгляд это может потенциально привести к ошибкам и усложнит поддержку.

Готовим свои типы

Отмечу, что для использования массивов можно использовать QList и для них не требуется маршаллизация и демаршаллизация, если для переменных уже есть преобразования.

Начинаем строить

Предположим есть два Qt приложения, которым нужно общаться по D-Bus. Одно приложение будет регистрироваться как сервис, а второе с этим сервисом взаимодействовать.

Я ленивый и мне лень создавать отдельный QDBus адаптер. Поэтому, для того что бы разделять внутренние методы и интерфейс D-Bus, интерфейсные методы отмечу макросом Q_SCRIPTABLE.

Метод qVariantFromValue с помощью черной магии, void указателей и тем, что мы зарегистрировали тип, преобразует его в QVariant. Обратно его можно получить через шаблон метода QVariant::value или через qvariant_cast.

Если нужен ответ метода, то можно использовать другие методы QDBusConnection — для синхронного call и для асинхронного callWithCallback, asyncCall.

Скачать пример можно отсюда.

Если всё идёт не настолько гладко
Тестирование интерфейса с пользовательскими типами
Тестирование сигналов

Для тестирования сигналов можно использовать qdbusviewer — он может приконнектится к сигналу и показать что за структуру он отправляет. Также для этого может подойти dbus-monitor — после указания адреса он будет показывать все исходящие сообщения интерфейса.

Тестирование методов

Переменные перечисляются через запятую.

Основные типы(в скобках обозначение в сигнатуре):
int(i) — число (пример: 42);
bool(b) — 1 или 0;
double(d) — число с точкой (пример: 3.1415);
string(s) — строка в кавычках (пример: ”string”);
Структуры берутся в скобки “(“ и “)”, переменные идут через запятую, запятую надо ставить даже когда в структуре один элемент.
Массивы — квадратные скобки “[“ и ”]”, переменные через запятую.


Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *