Встраивание объектов 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-представлении. См. следующие примеры:

• Модель списка строк
• Модель списка объектов
• Модель QAbstractItemModel

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

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