From 95afdf6c3841427e193003a02389cff0a784b548 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Fri, 28 Nov 2014 15:28:15 +0100 Subject: [PATCH] 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 --- doc/src/qtquick/qtquick-modules-with-plugins.qdoc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/src/qtquick/qtquick-modules-with-plugins.qdoc b/doc/src/qtquick/qtquick-modules-with-plugins.qdoc index f31fdaf2839..99ee6b328dd 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. + */