QQmlContext Class

成员函数文档

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

使用给定的parentContext 、QObject 以及parent 创建一个新的QQmlContext。

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

创建一个新的 QQmlContext，将其作为engine 的根上下文的子项，并将QObject parent 。

[override virtual noexcept] QQmlContext::~QQmlContext()

销毁QQmlContext 。

任何依赖于此上下文的表达式或子上下文都将失效，但不会被销毁（除非它们隶属于QQmlContext 对象）。

QUrl QQmlContext::baseUrl() const

返回组件的基准 URL；如果未设置基准 URL，则返回其父组件的基准 URL。

另请参阅 setBaseUrl()。

[since 6.11] QList<QQmlContext *> QQmlContext::childContexts() const

返回上下文的直接子节点 QQmlContexts。

该函数在 Qt 6.11 中引入。

另请参阅 parentContext()、findObjectRecursively() 和findObjectsRecursively()。

QObject *QQmlContext::contextObject() const

返回上下文对象；如果不存在上下文对象，则返回nullptr 。

另请参阅 setContextObject()。

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

返回此上下文中name 属性的值，该值以QVariant 的形式返回。如果已知要查找的属性是当前上下文中通过QML id分配的QObject ，则使用objectForName()会更方便且更快。 与objectForName() 和nameForObject() 不同，如果当前上下文中未找到name ，该方法会遍历上下文层次结构并在父上下文中进行搜索。它还会考虑您可能设置的任何contextObject()。

另请参阅 setContextProperty()、objectForName()、nameForObject() 以及contextObject()。

QQmlEngine *QQmlContext::engine() const

返回上下文的QQmlEngine ；如果上下文没有QQmlEngine ，或者QQmlEngine 已被销毁，则返回nullptr 。

[since 6.11] QObject *QQmlContext::findObjectRecursively(const QString &id) const

递归搜索当前上下文及其子上下文，查找 ID 为id 的对象。若找到该对象，则返回该对象；否则返回nullptr 。

在任何给定的上下文中，只能存在一个具有指定id 的对象，但您可以在一个文档中创建多个上下文，例如通过视图和委托。每个上下文都可能包含一个具有指定id 的对象。此处仅返回第一个找到的对象。搜索采用广度优先搜索算法进行。

该函数在 Qt 6.11 中引入。

另请参阅 findObjectsRecursively()、objectForName() 和childContexts()。

[since 6.11] QList<QObject *> QQmlContext::findObjectsRecursively(const QString &id) const

递归搜索当前上下文及其子上下文中 ID 为id 的对象，并返回这些对象的列表。

在任何给定的上下文中，ID 为id 的对象只能有一个，但您可以在一个文档中创建多个上下文，例如通过视图和委托。每个上下文中都可以包含一个 ID 为id 的对象。

该函数于 Qt 6.11 中引入。

另请参阅 findObjectRecursively()、objectForName() 和childContexts()。

bool QQmlContext::isValid() const

返回该上下文是否有效。

要成为有效的上下文，必须拥有一个引擎，且其contextObject()（如有）未被删除。

QString QQmlContext::nameForObject(const QObject *object) const

返回当前上下文中object 的名称；如果object 在该上下文中未被命名，则返回空字符串。对象可通过setContextProperty()进行命名，也可作为上下文对象的属性，而在QML创建的上下文中，则通过ID进行命名。

如果对象有多个名称，则返回第一个名称。

与contextProperty() 不同，此方法不会遍历上下文层次结构。如果在当前上下文中未找到该名称，则返回空字符串。

另请参见 contextProperty() 和objectForName()。

[since 6.2] QObject *QQmlContext::objectForName(const QString &name) const

返回此上下文中给定name 对应的对象。如果该上下文中不存在name ，或者与name 关联的值不是QObject ，则返回nullptr。对象可通过setContextProperty()进行命名，也可作为上下文对象的属性，对于QML创建的上下文，则通过ID进行命名。 与contextProperty()不同，此方法不会遍历上下文层次结构。如果在当前上下文中未找到该名称，则返回nullptr。

该函数在 Qt 6.2 中引入。

另请参见 contextProperty() 和nameForObject()。

QQmlContext *QQmlContext::parentContext() const

返回上下文的父对象QQmlContext ；如果该上下文没有父对象，或者其父对象已被销毁，则返回nullptr 。

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

将 URLsrc 解析为相对于包含该组件的组件的 URL。

另请参阅 QQmlEngine::baseUrl() 和setBaseUrl()。

void QQmlContext::setBaseUrl(const QUrl &baseUrl)

显式设置 `resolvedUrl()` 用于相对引用 `baseUrl` 的 URL。

调用此函数将覆盖包含组件默认使用的 URL。

另请参阅 baseUrl() 和resolvedUrl()。

void QQmlContext::setContextObject(QObject *object)

设置上下文object 。

另请参阅 contextObject()。

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

在此上下文中设置一批properties 。

一次性设置所有属性可避免不必要的表达式刷新，因此建议采用这种方式，而非针对每个属性单独调用setContextProperty()。

另请参阅 QQmlContext::setContextProperty()。

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

在此上下文中设置name 属性的value 。

QQmlContext 不会获取对 `value` 的所有权。

另请参阅 contextProperty()。

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

将此上下文中name 属性的value 属性设置为a。