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>
This commit is contained in:
Leena Miettinen
2014-11-28 15:28:15 +01:00
committed by Leena Miettinen
parent 47f9622e72
commit 95afdf6c38

View File

@@ -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.
*/