<QtPlugin> - Defining Plugins

マクロのドキュメント

Q_DECLARE_INTERFACE(ClassName, Identifier)

このマクロは、与えられたIdentifier （文字列リテラル）をClassName というインターフェース・クラスに関連付ける。Identifier は一意でなければならない。

このマクロは通常、ヘッダー・ファイルのClassName のクラス定義の直後に使用します。

Q_DECLARE_INTERFACE を名前空間で宣言されたインタフェース・クラスで使用したい場合は、 Q_DECLARE_INTERFACE が名前空間の中にないことを確認する必要があります。例えば

namespace Foo
{
    struct MyInterface { ... };
}

Q_DECLARE_INTERFACE(Foo::MyInterface, "org.examples.MyInterface")

Q_INTERFACES() やQt プラグインの作成方法も参照してください 。

Q_IMPORT_PLUGIN(PluginName)

このマクロは、PluginName というプラグインをインポートします。これは、Q_PLUGIN_METADATA() でプラグインのメタデータを宣言するクラスの名前に対応しています。

このマクロをアプリケーションのソースコードに挿入すると、静的プラグインを利用できるようになります。

例

Q_IMPORT_PLUGIN(qjpeg)

スタティック・プラグインは、アプリケーションのビルド時にリンカによってインクルードされる必要があります。これについては、スタティック・プラグインを参照してください。

スタティック・プラグインと Qt プラグインの作成方法も参照してください 。

Q_PLUGIN_METADATA(...)

このマクロは、このオブジェクトをインスタンス化するプラグインの一部であるメタデータを宣言するために使用されます。

このマクロは、オブジェクトを通して実装されるインターフェースの IID を宣言し、プラグインのメタデータを含むファイルを参照する必要があります。

このマクロは、Qtプラグインのソースコード中に1つだけ存在する必要があります。

例

class MyInstance : public QObject
{
    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QDummyPlugin" FILE "mymetadata.json")
};

このマクロが現れるクラスは、default-constructable でなければならないことに注意してください。

FILE はオプションで、json ファイルを指します。

jsonファイルは、ビルドシステムによって指定されたインクルードディレクトリの1つに存在する必要があります。指定されたファイルが見つからなかった場合、mocはエラーで終了します。

Q_DECLARE_INTERFACE() およびQt プラグインの作成方法も参照してください 。