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

Обзор

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

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

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

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

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

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

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

class Message
{
public:
    Message();
    Message(const Message &other);
    ~Message();

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

    QString 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)
{
    const QString body = message.body();
    QVector<QStringRef> pieces = body.splitRef("\r\n", QString::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() содержат более подробную информацию об их использовании и ограничениях.

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

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