QPluginLoader Class

メンバ関数のドキュメント

[explicit] QPluginLoader::QPluginLoader(QObject *parent = nullptr)

与えられたparent でプラグインローダーを構築します。

[explicit] QPluginLoader::QPluginLoader(const QString &fileName, QObject *parent = nullptr)

fileName で指定されたプラグインをロードする、与えられたparent でプラグインローダーを構築します。

ローダブルであるためには、ファイルのサフィックスが、プラットフォームに応じてローダブルライブラリの有効なサフィックスでなければなりません。例えば、Unixでは.so 、 - macOSとiOSでは.dylib 、Windowsでは.dll です。サフィックスはQLibrary::isLibrary() で確認できる。

setFileName()も参照のこと 。

[virtual noexcept] QPluginLoader::~QPluginLoader()

QPluginLoader オブジェクトを破棄する。

unload() が明示的に呼び出されない限り、プラグインはアプリケーションが終了するまでメモリーに残ります。

isLoaded() およびunload() も参照 。

QString QPluginLoader::errorString() const

最後に発生したエラーの説明をテキスト文字列で返します。

QObject *QPluginLoader::instance()

プラグインのルート・コンポーネント・オブジェクトを返します。プラグインは必要に応じてロードされます。プラグインをロードできなかった場合、またはルートコンポーネントオブジェクトをインスタンス化できなかった場合、この関数はnullptr を返します。

ルートコンポーネントオブジェクトが破棄された場合、この関数を呼び出すと新しいインスタンスが作成されます。

この関数によって返されたルートコンポーネントは、QPluginLoader が破棄されても削除されません。ルート・コンポーネントを確実に削除したい場合は、コア・コンポーネントにアクセスする必要がなくなり次第、unload （）を呼び出す必要がある。ライブラリが最終的にアンロードされると、ルート・コンポーネントは自動的に削除されます。

コンポーネント・オブジェクトはQObject である。興味のあるインターフェースにアクセスするには、qobject_cast() を使用する。

load()も参照 。

bool QPluginLoader::isLoaded() const

プラグインがロードされていればtrue を返し、そうでなければfalse を返す。

load() も参照 。

bool QPluginLoader::load()

プラグインをロードし、プラグインのロードに成功した場合はtrue を返し、そうでない場合はfalse を返します。instance() は、シンボルを解決する前に常にこの関数を呼び出すので、明示的に呼び出す必要はない。状況によっては、プラグインを事前に読み込んでおきたいこともあるでしょう。その場合は、この関数を使用します。

unload()も参照 。

QJsonObject QPluginLoader::metaData() const

このプラグインのメタデータを返します。メタデータは、プラグインのコンパイル時にQ_PLUGIN_METADATA() マクロを使用して json 形式で指定したデータです。

このメタデータは、プラグインを実際にロードすることなく、高速かつ安価な方法で問い合わせることができます。これにより、例えばプラグインの能力をそこに保存し、プラグインをロードするかどうかの決定をこのメタデータに依存させることが可能になります。

[static] QObjectList QPluginLoader::staticInstances()

プラグインローダーが保持する静的なプラグインインスタンス（ルートコンポーネント）のリストを返します。

staticPlugins()も参照してください 。

[static] QList<QStaticPlugin> QPluginLoader::staticPlugins()

プラグインローダーが保持するQStaticPluginsのリストを返します。この関数はstaticInstances() と似ていますが、QStaticPlugin にメタデータ情報が含まれている点が異なります。

staticInstances()も参照してください 。

bool QPluginLoader::unload()

プラグインをアンロードし、プラグインをアンロードできた場合はtrue を返し、そうでない場合はfalse を返します。

これはアプリケーションの終了時に自動的に行われるため、通常はこの関数を呼び出す必要はありません。

他のQPluginLoader インスタンスが同じプラグインを使用している場合、呼び出しは失敗し、アンロードはすべてのインスタンスがunload()を呼び出したときにのみ行われます。

ルート・コンポーネントを削除しようとしないでください。その代わりに、unload() が必要なときに自動的に削除してくれることを信じてください。

instance() およびload()も参照 。