QQmlEngineExtensionPlugin Class

詳細な説明

QQmlEngineExtensionPlugin は、QML アプリケーションに動的に読み込める QML 拡張機能を作成できるプラグインインターフェースです。これらの拡張機能により、カスタム QML タイプを QML エンジンで利用できるようになります。

QML拡張プラグインを作成するには：

1. QQmlEngineExtensionPlugin をサブクラス化し、Q_PLUGIN_METADATA()マクロを使用して、Qtメタオブジェクトシステムにプラグインを登録します。
2. QML_ELEMENT およびQML_NAMED_ELEMENT() マクロを使用して、QML 型を宣言します。
3. ビルドファイルを設定します。

   CMake:

   qt_add_qml_module(<target>
       URI <my.import.name>
       VERSION 1.0
       QML_FILES <app.qml>
       NO_RESOURCE_TARGET_PATH
   )

   qmake:

   CONFIG += qmltypes
   QML_IMPORT_NAME = <my.import.name>
   QML_IMPORT_MAJOR_VERSION = <version>

4. qmake を使用している場合は、プラグインを記述するためのqmldir ファイルを作成してください。なお、CMake ではデフォルトでqmldir ファイルが自動的に生成されます。

QML拡張プラグインは、アプリケーション固有のプラグイン、またはライブラリ型のプラグインのいずれかに使用されます。ライブラリ型プラグインは、型の登録に限定すべきです。エンジンのルートコンテキストを操作すると、ライブラリ利用者のコードで競合やその他の問題が発生する可能性があるためです。

リンカーは最適化の一環として、生成された型登録関数を誤って削除してしまう可能性があります。これを防ぐには、コード内のどこかに、その関数への合成のvolatileポインタを宣言してください。この関数はqmltyperegistrarによって生成され、qml_register_types_ にモジュールURIを連結した名前が付けられ、ドットはすべてアンダースコアに置き換えられます。

モジュール名が「my.module」の場合、グローバルスコープに以下の前方宣言を追加します。

void qml_register_types_my_module();

次に、登録関数と同じバイナリに含まれる任意の関数の実装内に、以下のコードスニペットを追加します:

volatile auto registration = &qml_register_types_my_module;
Q_UNUSED(registration);

「C++ を使用した QML 拡張機能の作成」チュートリアルには、QML プラグインの作成に関する章も含まれています。