From 9a5127a9d99ba2650e8a1f4c16c82876b7b915f9 Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Date: Mon, 22 Dec 2014 16:08:16 +0100
Subject: Doc: update docs for the Quit Installer example

Change-Id: I0b456962e9a07e16a3e44882d936f604fcd4f71f
Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
---
 .../doc/images/qtifw-examples-quit_installer.png   | Bin 0 -> 19682 bytes
 examples/doc/quit_installer.qdoc                   |  38 +++++++++++++++++++++
 2 files changed, 38 insertions(+)
 create mode 100644 examples/doc/images/qtifw-examples-quit_installer.png

(limited to 'examples/doc')

diff --git a/examples/doc/images/qtifw-examples-quit_installer.png b/examples/doc/images/qtifw-examples-quit_installer.png
new file mode 100644
index 000000000..12e94f0a1
Binary files /dev/null and b/examples/doc/images/qtifw-examples-quit_installer.png differ
diff --git a/examples/doc/quit_installer.qdoc b/examples/doc/quit_installer.qdoc
index bb1655ad2..55b9f3ba3 100644
--- a/examples/doc/quit_installer.qdoc
+++ b/examples/doc/quit_installer.qdoc
@@ -30,11 +30,49 @@
     \ingroup qtifwexamples
     \title Quit Installer Example
 
+    \image qtifw-examples-quit_installer.png
+
     \brief Quitting an installer by using a script.
 
+    \e{Quit Installer} illustrates how to use the \c Component() function to
+    display a message box to end users for quitting the installation if some
+    requirements for the installation are not met.
+
     \include installerfw-examples-configuring.qdocinc
 
     \quotefile quit_installer/config/config.xml
 
+    \include installerfw-examples-packaging.qdocinc
+
+    \list
+        \li The \c <Default> section is set to \c true to preselect the
+            component in the installer.
+        \li The \c <Script> section specifies the file name of the JavaScript
+            file that is loaded to perform operations.
+    \endlist
+
+    \quotefile quit_installer/packages/org.qtproject.ifw.example.quitinstaller/meta/package.xml
+
+    \section1 Quitting the Installation
+
+    In installscript.js, we use the \c Component() function to display a
+    message box for quitting the installer to end users:
+
+    \quotefromfile quit_installer/packages/org.qtproject.ifw.example.quitinstaller/meta/installscript.js
+    \skipto Component()
+    \printuntil QMessageBox.Ok
+
+    If end users select \uicontrol OK, we use the \c installer::setValue()
+    function to display a message and the \c installer.setDefaultPageVisible()
+    function to hide the subsequent installer pages:
+
+    \printuntil NextButton
+
+    If end users select \uicontrol Cancel, we display the default installer
+    pages and use the \c installer::setValue() function to display another
+    message on the last installer page:
+
+    \printuntil /^\}/
+
     \include installerfw-examples-generating.qdocinc
 */
-- 
cgit v1.2.3