Класс QQmlContext

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

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

Типы public

Public функции

• 31 public функции, унаследованные от QObject

Статические public члены

• 9 static public members inherited from QObject

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

• 1 свойство, унаследованное от QObject
• 1 public слот, унаследованный от QObject
• 2 сигнала, унаследованные от QObject
• 9 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 в данном контексте или пустую строку, если объект не имеет имени в контексте. Объекты получают имена с помощью setContextProperty() или по id в случае контекстов, созданных в 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 в этом контексте.