Встраивание объектов C++ в QML с помощью свойств контекста

При загрузке объекта QML в приложение C++, может быть полезно напрямую встроить некоторые данные C++, которые можно использовать из кода QML. Это позволяет, например, вызывать метод C++ на встроенном объекте или использовать экземпляр объекта C++ в качестве модели данных для QML-представления.

Возможность встраивания данных C++ в объект QML обеспечивается классом QQmlContext. Этот класс предоставляет данные контексту объекта QML, чтобы к ним можно было напрямую обратиться из области кода QML.

Установка простого свойства контекста

Например, вот элемент QML, который ссылается на значение currentDateTime, которое не существует в текущей области:

// MyItem.qml
import QtQuick 2.0

Text { text: currentDateTime }

Это значение currentDateTime можно установить напрямую приложением C++, которое загружает QML-компонент, используя QQmlContext::setContextProperty():

QQuickView view;
view.rootContext()->setContextProperty("currentDateTime", QDateTime::currentDateTime());
view.setSource(QUrl::fromLocalFile("MyItem.qml"));
view.show();

Примечание: Поскольку все выражения, вычисляемые в QML, вычисляются в определённом контексте, если контекст изменён, все привязки в этом контексте будут переоценены. Поэтому свойства контекста следует использовать с осторожностью вне инициализации приложения, так как это может привести к снижению производительности приложения.

Установка объекта как свойства контекста

Свойства контекста могут содержать значения QVariant или QObject*. Это означает, что пользовательские объекты C++ также могут быть встроены с помощью этого подхода, и к этим объектам можно напрямую обращаться и изменять их в QML. Здесь мы изменяем пример выше, чтобы встроить экземпляр QObject вместо значения QDateTime, и код QML вызывает метод экземпляра объекта:

class ApplicationData : public QObject
{
    Q_OBJECT
public:
    Q_INVOKABLE QDateTime getCurrentDateTime() const {
        return QDateTime::currentDateTime();
    }
};

int main(int argc, char *argv[]) {
    QGuiApplication app(argc, argv);

    QQuickView view;

    ApplicationData data;
    view.rootContext()->setContextProperty("applicationData", &data);

    view.setSource(QUrl::fromLocalFile("MyItem.qml"));
    view.show();

    return app.exec();
}

// MyItem.qml
import QtQuick 2.0

Text { text: applicationData.getCurrentDateTime() }

(Обратите внимание, что значения даты/времени, возвращаемые из C++ в QML, могут быть отформатированы с помощью Qt.formatDateTime() и связанных функций.)

Если элементу QML необходимо получать сигналы от свойства контекста, он может подключиться к ним с помощью типа Подключения. Например, если ApplicationData имеет сигнал с именем dataChanged(), этот сигнал можно подключить с помощью обработчика onDataChanged внутри объекта Подключения:

Text {
    text: applicationData.getCurrentDateTime()

    Connections {
        target: applicationData
        onDataChanged: console.log("The application data changed!")
    }
}

Свойства контекста могут быть полезны для использования моделей данных на основе C++ в представлении QML. Смотрите следующие примеры:

• Модель списка строк
• Модель списка объектов
• Модель абстрактного элемента

демонстрирующие использование моделей на основе QStringList, QList<QObject*> и QAbstractItemModel в QML-представлениях.

Также см. документацию QQmlContext для получения дополнительной информации.