Класс QQmlContext

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

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

Типы публичного доступа

Функции публичного доступа

• 34 функции публичного доступа, унаследованные от QObject

Дополнительные унаследованные члены

• 1 свойство, унаследованное от QObject
• 1 public slot, унаследованный от QObject
• 2 сигнала, унаследованные от QObject
• 1 public переменная, унаследованная от QObject
• 10 статические public члены, унаследованные от QObject
• 9 protected функций, унаследованные от QObject
• 2 protected переменных, унаследованные от QObject

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

Класс 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(QQmlEngine *engine, QObject *parent = nullptr)

Создает новый QQmlContext как дочерний элемент корневого контекста engine, и QObject parent.

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

Создает новый QQmlContext с заданным parentContext и 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)

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

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

void QQmlContext::setContextProperties(const QVector<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 в этом контексте.