path: root/doc
diff options
authorChristian Kandeler <christian.kandeler@qt.io>2018-11-05 10:42:12 +0100
committerChristian Kandeler <christian.kandeler@qt.io>2018-11-09 13:42:42 +0000
commit5f1b52e1c6f7668c3ea21ec11fde818ee6efd521 (patch)
tree6cc361275a896ef37ee80df96aed09a108ba966f /doc
parent66e1be8b18967aba395238cc71bb13eff631eaac (diff)
Qt support: Allow users to pull in plugins by type
... and properly set the default values. Fixes: QBS-1409 Change-Id: Ib8f3573fcb48d395d9212ac4b01e5caf910c575f Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Diffstat (limited to 'doc')
2 files changed, 78 insertions, 11 deletions
diff --git a/doc/reference/items/convenience/qtguiapplication.qdoc b/doc/reference/items/convenience/qtguiapplication.qdoc
index 09b8514f5..e69b9214c 100644
--- a/doc/reference/items/convenience/qtguiapplication.qdoc
+++ b/doc/reference/items/convenience/qtguiapplication.qdoc
@@ -37,15 +37,5 @@
\brief Application with a dependency on the Qt GUI module.
A QtGuiApplication is an application that extends the \l{QtApplication} item
- by loading the \l{Qt.gui} module and possibly also the default
- QPA plugin.
- \qmlproperty bool QtGuiApplication::linkDefaultQpaPlugin
- Whether or not to add a depencency to the default QPA plugin. The default is
- to do that in the case of a static build, where it is normally required.
- \defaultvalue \l{Qt.core::staticBuild}{Qt.core.staticBuild}
+ by loading the \l{Qt.gui} module.
diff --git a/doc/reference/modules/qt-plugin_support-module.qdoc b/doc/reference/modules/qt-plugin_support-module.qdoc
new file mode 100644
index 000000000..fe28ee907
--- /dev/null
+++ b/doc/reference/modules/qt-plugin_support-module.qdoc
@@ -0,0 +1,77 @@
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+** This file is part of Qbs.
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+ \contentspage index.html
+ \qmltype Qt.plugin_support
+ \inqmlmodule QbsModules
+ \since Qbs 1.13.0
+ \brief Allows to fine-tune which Qt plugins get pulled in.
+ The \c Qt.plugin_support module provides properties that allow users to control
+ which Qt plugins to pull into a product.
+ This is mostly relevant if Qt was built statically, in which case the respective
+ plugins are static libraries that get linked into your application or library.
+ \qmlproperty varList Qt.plugin_support::pluginsByType
+ Set this property if you want to override the set of plugins for a certain
+ plugin type. For instance, to disable all image plugins except the JPEG
+ one:
+ \code
+ Qt.plugin_support.pluginsByType: ({imageformats: "qjpeg"})
+ \endcode
+ For plugin types that are not specifically overridden like this, the value in
+ defaultPluginsByType is used.
+ \nodefaultvalue
+ \qmlproperty var Qt.plugin_support::allPluginsByType
+ Provides the complete set of plugins in a statically built Qt.
+ The value is a map. The keys are the plugin types, and the values
+ are lists of plugin names.
+ \readonly
+ \qmlproperty var Qt.plugin_support::defaultPluginsByType
+ Provides the set of plugins that your application or library will
+ link to if you do not set pluginsByType.
+ The value is a map. The keys are the plugin types, and the values
+ are lists of plugin names.
+ The value depends on the Qt modules your product pulls in.
+ \readonly