QQmlContext Class

メンバ関数ドキュメント

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

新しい QQmlContext を、与えられたparentContext とQObject parent で作成します。

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

engine'のルートコンテキストの子として新しいQQmlContextを作成し、QObject parent 。

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

QQmlContext を破棄する。

このコンテキストに依存している式やサブコンテキストはすべて無効になるが、破棄はされない（QQmlContext オブジェクトの親になっている場合を除く）。

QUrl QQmlContext::baseUrl() const

コンポーネントのベース URL、あるいは何も設定されていない場合は 含むコンポーネントを返します。

setBaseUrl()も参照ください 。

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 を返す。

bool QQmlContext::isValid() const

コンテキストが有効かどうかを返します。

有効であるためには、コンテキストはエンジンを持たなければならず、contextObject() がある場合はそれが削除されていなければなりません。

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

このコンテキストにおけるobject の名前を返します。object の名前がコンテキストにない場合は空文字列を返します。オブジェクトの名前は、setContextProperty()、コンテキストオブジェクトのプロパティ、QMLで作成されたコンテキストの場合はidsで指定します。

オブジェクトに複数の名前がある場合は、最初の名前が返されます。

contextProperty() とは対照的に、このメソッドはコンテキスト階層を走査しません。現在のコンテキストにその名前がない場合は、空の文字列が返されます。

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

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

このコンテキストで指定されたname のオブジェクトを返す。name がコンテキストにない場合、またはname に関連付けられた値がQObject でない場合は nullptr を返します。 オブジェクトの名前はsetContextProperty() で指定するか、コンテキストオブジェクトのプロパティとして指定するか、QML で作成されたコンテキストの場合は ids で指定します。contextProperty() とは対照的に、このメソッドはコンテキスト階層を走査しません。現在のコンテキストで名前が見つからない場合、nullptr が返されます。

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

contextProperty() およびnameForObject()も参照してください 。

QQmlContext *QQmlContext::parentContext() const

コンテキストの親QQmlContext を返すか、このコンテキストに親がないか、親が破棄された場合はnullptr を返す。

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

src の URL を、それを含むコンポーネントの URL からの相対 URL に解決する。

QQmlEngine::baseUrl() およびsetBaseUrl()も参照 。

void QQmlContext::setBaseUrl(const QUrl &baseUrl)

baseUrl への相対参照に使用する urlresolvedUrl() を明示的に設定します。

この関数をコールすると、デフォルトで使用されるコンポーネントの 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 を設定します。