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

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

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