Класс QQmlContext

Класс QQmlContext определяет контекст в движке QML. Подробнее...

• Список всех членов, включая унаследованные

Открытые типы

Открытые функции

Подробное описание

Контексты позволяют данным быть доступными для компонентов QML, созданных движком QML.

Каждый QQmlContext содержит набор свойств, отличных от свойств QObject, которые позволяют явно привязывать данные к контексту по имени. Свойства контекста определяются и обновляются с помощью вызова QQmlContext::setContextProperty(). Следующий пример показывает привязку модели Qt к контексту и последующий доступ к ней из файла QML.

QQmlEngine engine;
QStringListModel modelData;
QQmlContext *context = new QQmlContext(engine.rootContext());
context->setContextProperty("myModel", &modelData);

QQmlComponent component(&engine);
component.setData("import QtQuick 2.0\nListView { model: myModel }", QUrl());
QObject *window = component.create(context);

Обратите внимание, что создание и удаление QQmlContext — ответственность создателя. Если объект context в примере больше не нужен, когда уничтожается экземпляр компонента window, то context необходимо явно уничтожить. Проще всего это сделать, установив window как родителя context.

Для упрощения привязки и работы с большими наборами данных, можно установить объект контекста на QQmlContext. Все свойства объекта контекста доступны по имени в контексте, как если бы они были добавлены по отдельности через вызовы QQmlContext::setContextProperty(). Изменения значений свойств отслеживаются через сигнал уведомления о свойстве. Установка объекта контекста быстрее и проще, чем ручное добавление и поддержание значений свойств контекста.

Следующий пример имеет тот же эффект, что и предыдущий, но использует объект контекста.

class MyDataSet : ... {
    ...
    Q_PROPERTY(QAbstractItemModel *myModel READ model NOTIFY modelChanged)
    ...
};

MyDataSet myDataSet;
QQmlEngine engine;
QQmlContext *context = new QQmlContext(engine.rootContext());
context->setContextObject(&myDataSet);

QQmlComponent component(&engine);
component.setData("import QtQuick 2.0\nListView { model: myModel }", QUrl());
component.create(context);

Все свойства, добавленные явно с помощью QQmlContext::setContextProperty(), имеют приоритет над свойствами объекта контекста.

Иерархия контекстов

Контексты образуют иерархию. Корнем этой иерархии является корневой контекст движка QML. Подконтексты наследуют свойства контекста своих родителей; если подконтекст задаёт свойство контекста, которое уже существует у родителя, новое свойство контекста переопределяет свойство родителя.

Следующий пример определяет два контекста - context1 и context2. Второй контекст переопределяет свойство контекста "b", унаследованное от первого, новым значением.

QQmlEngine engine;
QQmlContext *context1 = new QQmlContext(engine.rootContext());
QQmlContext *context2 = new QQmlContext(context1);

context1->setContextProperty("a", 12);
context1->setContextProperty("b", 12);

context2->setContextProperty("b", 15);

Хотя объекты QML, созданные в контексте, не являются строго принадлежащими этому контексту, их привязки являются. Если контекст уничтожается, привязки свойств оставшихся объектов QML перестанут оцениваться.

Предупреждение: Установка объекта контекста или добавление новых свойств контекста после создания объекта в этом контексте — дорогостоящая операция (в сущности, она заставляет все привязки переоцениваться). Поэтому, по возможности, следует завершить «настройку» контекста до его использования для создания любых объектов.

См. также Размещение атрибутов C++ типов в QML.

Документация по функциям-членам

QQmlContext::QQmlContext(QQmlContext *parentContext, QObject *parent = nullptr)

Создаёт новый QQmlContext с заданным parentContext и QObject parent.

QQmlContext::QQmlContext(QQmlEngine *engine, QObject *parent = nullptr)

Создаёт новый QQmlContext как подконтекст корневого контекста engine и QObject parent.

[override virtual] QQmlContext::~QQmlContext()

Уничтожает QQmlContext.

Любые выражения или подконтексты, зависящие от этого контекста, будут недействительными, но не уничтожатся (если они не являются дочерними для объекта QQmlContext).

QUrl QQmlContext::baseUrl() const

Возвращает базовый URL компонента или содержащего компонента, если он не установлен.

См. также setBaseUrl().

QObject *QQmlContext::contextObject() const

Возвращает объект контекста или 0, если объекта контекста нет.

См. также setContextObject().

QVariant QQmlContext::contextProperty(const QString &name) const

Возвращает значение свойства name для этого контекста как QVariant.

См. также setContextProperty().

QQmlEngine *QQmlContext::engine() const

Возвращает QQmlEngine контекста или 0, если у контекста нет QQmlEngine или QQmlEngine был уничтожен.

bool QQmlContext::isValid() const

Возвращает, является ли контекст допустимым.

Для того, чтобы контекст был допустимым, он должен иметь движок, и его contextObject(), если таковой есть, не должен быть удалён.

QString QQmlContext::nameForObject(QObject *object) const

Возвращает имя object в этом контексте или пустую строку, если object не имеет имени в контексте. Объекты имеют имена благодаря setContextProperty(), или по идентификаторам в случае контекстов, созданных QML.

Если у объекта несколько имён, возвращается первое.

QQmlContext *QQmlContext::parentContext() const

Возвращает родительский QQmlContext контекста или 0, если у этого контекста нет родителя или родитель был уничтожен.

QUrl QQmlContext::resolvedUrl(const QUrl &src)

Разрешает URL src относительно URL содержащего компонента.

См. также QQmlEngine::baseUrl() и setBaseUrl().

void QQmlContext::setBaseUrl(const QUrl &baseUrl)

Явно устанавливает url, который resolvedUrl() будет использовать для относительных ссылок к baseUrl.

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

См. также baseUrl() и resolvedUrl().

void QQmlContext::setContextObject(QObject *object)

Устанавливает контекстный объект.

См. также contextObject().

void QQmlContext::setContextProperties(const QVector<QQmlContext::PropertyPair> &properties)

Устанавливает пакет свойств в этом контексте.

Установка всех свойств в одной группе избегает ненужного обновления выражений и поэтому рекомендуется вместо вызова setContextProperty() для каждого отдельного свойства.

Эта функция была добавлена в Qt 5.11.

См. также QQmlContext::setContextProperty().

void QQmlContext::setContextProperty(const QString &name, QObject *value)

Устанавливает значение свойства name в этом контексте.

QQmlContext не принимает на себя ответственность за value.

См. также contextProperty().

void QQmlContext::setContextProperty(const QString &name, const QVariant &value)

Устанавливает значение свойства name в этом контексте.