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

• Список строк Model
• Список объектов Model
• AbstractItemModel

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

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