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

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

C++のデータをQMLオブジェクトに注入する機能は、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!")
    }
}

コンテキスト・プロパティは、C++ベースのデータモデルをQMLビューで使用する際 に便利です。以下の例を参照してください：

• 文字列 ListModel
• オブジェクト ListModel
• AbstractItemModel

QStringList 、QList<QObject*>ベースのモデル、QAbstractItemModel を QML ビューで使用する例を示します。

また、QQmlContext のドキュメントも参照してください。