qt_import_plugins

インポートまたは除外するカスタムプラグインセットを指定します。

このコマンドは、Qt6 パッケージのCore コンポーネントで定義されており、次のように読み込むことができます:

find_package(Qt6 REQUIRED COMPONENTS Core)

このコマンドは Qt 5.14 で導入されました。

概要

qt_import_plugins(target
                  [INCLUDE plugin ...]
                  [EXCLUDE plugin ...]
                  [INCLUDE_BY_TYPE plugin_type plugin ...]
                  [EXCLUDE_BY_TYPE plugin_type]
                  [NO_DEFAULT]
)

バージョン指定なしのコマンドが無効になっている場合は、代わりに `qt6_import_plugins() ` を使用してください。このコマンドと同じ引数セットをサポートしています。

説明

インポートするプラグインのカスタムセットを指定します。オプションの引数である `INCLUDE`、`EXCLUDE`、`INCLUDE_BY_TYPE`、および `EXCLUDE_BY_TYPE` は、複数回使用できます。

• INCLUDE – を使用すると、インポートするプラグインのリストを指定できます。
• EXCLUDE – 除外するプラグインのリストを指定するために使用できます。
• INCLUDE_BY_TYPE – 特定のプラグインタイプについて、インポートするプラグインのリストを上書きするために使用できます。
• EXCLUDE_BY_TYPE – 除外するプラグインの種類を指定するために使用できます。これにより、その種類のプラグインはインポートされなくなります。
• NO_DEFAULT – デフォルトのプラグイン（たとえば、デフォルトのプラットフォームプラグイン）が自動的に含まれるのを防ぎます。

Qt には、imageformats 、platforms 、sqldrivers などのプラグインタイプが用意されています。

動的プラグイン

プラグインがダイナミックライブラリの場合、この関数によってプラグインのデプロイが制御されます。この関数を使用すると、特定のプラグインタイプを Android APK へのパッケージ化から除外できます。例えば、次のようにします。

qt_add_executable(MyApp ...)
...
qt_import_plugins(MyApp EXCLUDE_BY_TYPE imageformats)

上記のコードスニペットでは、MyApp を展開する際、imageformats 型のすべてのプラグインが除外されます。結果として生成されるAndroid APKには、imageformats のプラグインは一切含まれません。

このコマンドを使用しない場合、ターゲットは、そのターゲットがリンクされているQtモジュールに属するすべてのプラグインを自動的にデプロイします。

静的プラグイン

このコマンドが使用されない場合、ターゲットは、リンクされている各 Qt モジュールに対して、適切なデフォルトの静的プラグインセットを自動的にリンクします。詳細については、target_link_libraries を参照してください。

各プラグインには、静的プラグインを自動的に初期化する C++ スタブファイルが付属しています。その結果、プラグインにリンクするターゲットには、この C++ ファイルが `SOURCES` に追加されます。

例

qt_add_executable(myapp main.cpp)
target_link_libraries(myapp Qt6::Gui Qt6::Sql)
qt_import_plugins(myapp
    INCLUDE Qt6::QCocoaIntegrationPlugin
    EXCLUDE Qt6::QMinimalIntegrationPlugin
    INCLUDE_BY_TYPE imageformats Qt6::QGifPlugin Qt6::QJpegPlugin
    EXCLUDE_BY_TYPE sqldrivers
)

上記のコードスニペットでは、実行可能ファイルのmyapp に対して以下の処理が行われます：

• Qt6::QCocoaIntegrationPlugin が myapp にインポートされます。
• Qt6::QMinimalIntegrationPlugin プラグインは、myapp への自動インポート対象から除外されます。
• imageformats のデフォルトのプラグイン一覧は、Qt6::QGifPlugin とQt6::QJpegPlugin のみを含むように上書きされます。
• すべてのsqldrivers プラグインは、自動インポートの対象から除外されます。