Класс 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(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 в этом контексте.