aboutsummaryrefslogtreecommitdiffstats
path: root/doc/api/plugin-metadata.qdoc
diff options
context:
space:
mode:
authorEike Ziller <eike.ziller@qt.io>2017-01-04 06:23:32 +0100
committerEike Ziller <eike.ziller@qt.io>2017-01-09 12:25:08 +0000
commit284fa63be2b2af4d16926bc7cc17ca30cf0b5e39 (patch)
tree2bc8424f485c8ec84a6836d4d7d09153714f3f92 /doc/api/plugin-metadata.qdoc
parentb29513aa5b63c3abfef79e928bc803f471663eb4 (diff)
Support 'hidden' plugins
Plugins can be hidden in the "About Plugins" view by default. Users can still make them all visible, but the default view can be made less noisy by hiding plugins that only exist as a base for other plugins. Plugins that can not run on the current platform are hidden by default as well. Change-Id: Iaf2f751c4ea4b3afc605bbbea6611eea042e62c7 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: hjk <hjk@qt.io>
Diffstat (limited to 'doc/api/plugin-metadata.qdoc')
-rw-r--r--doc/api/plugin-metadata.qdoc7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/api/plugin-metadata.qdoc b/doc/api/plugin-metadata.qdoc
index 83641974d7e..bb772f056cf 100644
--- a/doc/api/plugin-metadata.qdoc
+++ b/doc/api/plugin-metadata.qdoc
@@ -82,6 +82,13 @@
enabled by the user. This should be done for plugins which are not expected
to be used by so many people as to justify the additional resource consumption.
\row
+ \li HiddenByDefault
+ \li Boolean
+ \li Optional. Defaults to \c false.
+ If set, the plugin is not shown in the default view in the
+ \uicontrol {About Plugins...} dialog, but only if the user requests seeing all
+ plugins. It is still shown with the \c{-version} command line option.
+ \row
\li Required
\li Boolean
\li Optional. Defaults to \c false.