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

Обзор

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

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

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

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

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

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

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

class Message
{
public:
    Message() = default;
    ~Message() = default;
    Message(const Message &) = default;
    Message &operator=(const Message &) = default;

    Message(const QString &body, const QStringList &headers);

    QStringView body() const;
    QStringList headers() const;

private:
    QString m_body;
    QStringList m_headers;
};

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

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

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

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

Q_DECLARE_METATYPE(Message);

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

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

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

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

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

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

int main(int argc, char *argv[])
{
    QApplication app(argc, argv);
    ...
    qRegisterMetaType<Block>();
    ...
    return app.exec();
}

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

Window::Window(QWidget *parent)
    : QWidget(parent), thread(new RenderThread(this))
{
    ...
    connect(thread, &RenderThread::sendBlock,
            this, &Window::addBlock);
    ...
    setWindowTitle(tr("Queued Custom Type"));
}

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

QObject::connect: Cannot queue arguments of type 'Block'
(Make sure 'Block' is registered using qRegisterMetaType().)

Вывод типа на печать

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

    Message message(body, headers);
    qDebug() << "Original:" << message;

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

QDebug operator<<(QDebug dbg, const Message &message);

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

QDebug operator<<(QDebug dbg, const Message &message)
{
    QList<QStringView> pieces = message.body().split(u"\r\n", Qt::SkipEmptyParts);
    if (pieces.isEmpty())
        dbg.nospace() << "Message()";
    else if (pieces.size() == 1)
        dbg.nospace() << "Message(" << pieces.first() << ")";
    else
        dbg.nospace() << "Message(" << pieces.first() << " ...)";
    return dbg.maybeSpace();
}

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

Дополнительная информация

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

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

Документ Методы отладки предоставляет обзор механизмов отладки, обсуждаемых выше.