コンテキストプロパティを使用したC++オブジェクトのQMLへの埋め込み

QML オブジェクトを C++ アプリケーションに読み込む際、QML コード内から使用できる C++ データを直接埋め込むと便利な場合があります。これにより、たとえば、埋め込まれたオブジェクトの C++ メソッドを呼び出したり、C++ オブジェクトのインスタンスを QML ビューのデータモデルとして使用したりすることが可能になります。

QMLオブジェクトにC++データを注入する機能は、QQmlContext クラスによって実現されます。このクラスは、QMLオブジェクトのコンテキストに対してデータを公開し、QMLコードのスコープ内からそのデータに直接参照できるようにします。

単純なコンテキストプロパティの設定

たとえば、以下は、現在のスコープ内に存在しない `currentDateTime ` の値を参照する QML アイテムです。

// MyItem.qml
import QtQuick

Text { text: currentDateTime }

このcurrentDateTime の値は、QMLコンポーネントを読み込むC++アプリケーションから、QQmlContext::setContextProperty() を使用して直接設定できます：

QQuickView view;
view.rootContext()->setContextProperty("currentDateTime", QDateTime::currentDateTime());
view.setSource(QUrl::fromLocalFile("MyItem.qml"));
view.show();

オブジェクトをコンテキストプロパティとして設定する

コンテキストプロパティには、QVariant またはQObject*の値を格納できます。つまり、このアプローチを使用してカスタムC++オブジェクトを注入することも可能であり、これらのオブジェクトはQML内で直接変更および読み取りが可能です。ここでは、上記の例を修正して、QDateTime 値の代わりにQObject インスタンスを埋め込み、QMLコードからそのオブジェクトインスタンスのメソッドを呼び出します:

class ApplicationData : public QObject
{
    Q_OBJECT
public:
    Q_INVOKABLE QDateTime getCurrentDateTime() const {
        return QDateTime::currentDateTime();
    }
};

int main(int argc, char *argv[]) {
    QGuiApplication app(argc, argv);

    QQuickView view;

    ApplicationData data;
    view.rootContext()->setContextProperty("applicationData", &data);

    view.setSource(QUrl::fromLocalFile("MyItem.qml"));
    view.show();

    return app.exec();
}

// MyItem.qml
import QtQuick

Text { text: applicationData.getCurrentDateTime() }

（C++ から QML へ返される日付/時刻の値は、Qt.formatDateTime() および関連関数を使用してフォーマットできることに注意してください。）

QMLアイテムがコンテキストプロパティからのシグナルを受信する必要がある場合は、Connections 型を使用してそれらに接続できます。たとえば、ApplicationData にdataChanged() という名前のシグナルがある場合、このシグナルには、Connections オブジェクト内のonDataChanged ハンドラを使用して接続できます:

Text {
    text: applicationData.getCurrentDateTime()

    Connections {
        target: applicationData
        onDataChanged: console.log("The application data changed!")
    }
}

詳細については、QQmlContext のドキュメントも参照してください。