Встраивание объектов 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 должен получать сигналы от свойства контекста, он может подключаться к ним с помощью типа Connections. Например, если ApplicationData имеет сигнал с именем dataChanged(), этот сигнал может быть подключен с помощью обработчика onDataChanged в объекте Connections:

Text {
    text: applicationData.getCurrentDateTime()

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

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

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

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

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