Класс QQmlContext

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

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

Типы public

Функции public

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

Контексты позволяют предоставлять данные 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(). Изменения значений свойств распознаются через сигнал notify свойства. Установка объекта контекста быстрее и проще, чем ручная добавка и поддержание значений свойств контекста.

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

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(const QObject *object) const

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

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

QQmlContext *QQmlContext::parentContext() const

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

QUrl QQmlContext::resolvedUrl(const QUrl &src) const

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

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

void QQmlContext::setBaseUrl(const QUrl &baseUrl)

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

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

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

void QQmlContext::setContextObject(QObject *object)

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

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

[since 5.11] void QQmlContext::setContextProperties(const QList<QQmlContext::PropertyPair> &properties)

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

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

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

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

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

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

QQmlContext не принимает владение value.

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

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

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