Создание пользовательских типов 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()
{
    thread = new RenderThread();
    ...
    connect(thread, SIGNAL(sendBlock(Block)), this, SLOT(addBlock(Block)));
    ...
    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() содержит более подробную информацию об их использовании и ограничениях.

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

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