QQmlContext Class

メンバ関数のドキュメント

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

指定されたparentContext 、およびQObject parent を使用して、新しいQQmlContextを作成します。

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

engine のルートコンテキストの子として新しいQQmlContextを作成し、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 を持つオブジェクトは 1 つしか存在しませんが、1 つのドキュメント内に、たとえばビューやデリゲートなどを通じて複数のコンテキストを作成することは可能です。それらの各コンテキストには、指定されたid を持つオブジェクトが含まれている可能性があります。ここでは、最初に見つかったもののみが返されます。検索は幅優先探索（BFS）を用いて行われます。

この関数はQt 6.11で導入されました。

findObjectsRecursively()、objectForName()、およびchildContexts()も参照してください 。

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

このコンテキストとその子要素を再帰的に検索し、IDがid のオブジェクトを探します。これらのオブジェクトのリストを返します。

任意のコンテキスト内には、指定されたid を持つオブジェクトは1つしか存在できませんが、1つのドキュメント内に、たとえばビューやデリゲートなどを通じて複数のコンテキストを作成することは可能です。それらの各コンテキストには、指定された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 を設定します。