summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@digia.com>2014-11-28 15:28:15 +0100
committerLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2014-12-01 11:31:37 +0100
commit95afdf6c3841427e193003a02389cff0a784b548 (patch)
tree52d5c9c7768144e165c92c1e4fd78f5714fb1db9
parent47f9622e727c0bdac1b9ed447338ac99af04dea4 (diff)
downloadqt-creator-95afdf6c3841427e193003a02389cff0a784b548.tar.gz
Doc: QML_PUPPET_MODE env variable
The variable was added for checking whether a QML plugin is run in Design mode or by an application. Task-number: QTCREATORBUG-12439 Change-Id: Iad99b7279c8191cb8b17ca81ff24fb9db731fdc9 Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
-rw-r--r--doc/src/qtquick/qtquick-modules-with-plugins.qdoc6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/src/qtquick/qtquick-modules-with-plugins.qdoc b/doc/src/qtquick/qtquick-modules-with-plugins.qdoc
index f31fdaf283..99ee6b328d 100644
--- a/doc/src/qtquick/qtquick-modules-with-plugins.qdoc
+++ b/doc/src/qtquick/qtquick-modules-with-plugins.qdoc
@@ -101,4 +101,10 @@
\gui {Use QML emulation layer which is built by the selected Qt} radio button.
\QC builds the emulation layer when you select the \gui Design mode.
+ A plugin should behave differently depending on whether it is run by the
+ emulation layer or an application. For example, animations should not be run
+ in the \gui Design mode. You can use the value of the QML_PUPPET_MODE
+ environment variable to check whether the plugin is currently being run
+ by an application or edited in the \gui Design mode.
+
*/