aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc
diff options
context:
space:
mode:
authorTim Jenssen <tim.jenssen@digia.com>2014-08-28 16:51:00 +0200
committerThomas Hartmann <Thomas.Hartmann@digia.com>2014-08-28 16:52:02 +0200
commite64b6245a91a9d2bd269452c772c7c6eea784b39 (patch)
tree7991c4cbfc7a0b702fef6b8a3e9cb362a2b9ce8b /src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc
parent26fb6a0915ec64d30eaa78e781e7f18468bc2ed7 (diff)
Add new property "designersupported" to qmldir
This patch adds a property called "designersupported" to qmldir. This allows the Qt Quick Designer to only load plugins that have the line ""designersupported"" in their qmldir file. So the designer can load sub components without risking to load plugins that have never been tested in the designer and that might crash. The check for "designersupported"" is activated by using QQmlImports::setDesignerSupportRequired(). Change-Id: I4bf07cc163faa47996eacb1365a7961c51c51060 Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com> Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>
Diffstat (limited to 'src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc')
-rw-r--r--src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc b/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc
index ef6c8b1b67..a3ea25c005 100644
--- a/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc
+++ b/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc
@@ -221,6 +221,28 @@ typeinfo mymodule.qmltypes
\code
# this is a comment
\endcode
+
+ \row
+ \li designersupported
+ \li
+ \code
+ designersupported
+ \endcode
+
+ \li Set this property if the plugin is supported by Qt Quick Designer.
+ By default, the plugin will not be supported.
+
+ A plugin that is supported by Qt Quick Designer has to be properly
+ tested. This means that the plugin does not crash when running inside
+ the qml2puppet that is used by Qt Quick Designer to execute QML.
+ Generally the plugin should work well in the Qt Quick Designer
+ and not cause any show stoppers, like taking huge amounts of memory,
+ slowing down the qml2puppet heavily or anything else that renders
+ the plugin effectively unusable in the Qt Quick Designer.
+
+ The items of an unsupported plugin are not painted in the Qt Quick Designer,
+ but they are still available as empty boxes and the properties can be edited.
+
\endtable
Each command in a \c qmldir file must be on a separate line.