QPluginLoader Class

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

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

指定されたparent を使用して、プラグインローダーを構築します。

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

指定されたparent を使用して、fileName で指定されたプラグインを読み込むプラグインローダーを構築します。

ファイルがロード可能であるためには、そのファイル拡張子がプラットフォームに応じたロード可能なライブラリの有効な拡張子でなければなりません。例えば、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()も参照してください 。