Создание пользовательских типов 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 и извлекать их позже. См. пример Custom Type Example для кода, демонстрирующего это.

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

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

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

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

Пример Queued Custom Type Example объявляет класс 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 в Custom Type Example прилагает усилия для создания выводимого представления, насколько это возможно:

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() содержат более подробную информацию об их использовании и ограничениях.

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

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