diff options
author | Kai Koehne <kai.koehne@theqtcompany.com> | 2015-01-21 10:03:13 +0100 |
---|---|---|
committer | Kai Koehne <kai.koehne@theqtcompany.com> | 2015-01-21 10:14:50 +0100 |
commit | 711c579ffa053acfe49879960bfb1b1b1b5f4c8b (patch) | |
tree | db9036908d52db1dedf74fe5dd07a9132d7c547d /examples/doc/quit_installer.qdoc | |
parent | 515b96469d39c8dfd5ba823ecac371414c02e552 (diff) | |
parent | 7b584f55c2fee55aabd852aa836d6d8295ee1b22 (diff) |
Merge remote-tracking branch 'origin/2.0'
Conflicts:
dist/config/config.xml
dist/packages/org.qtproject.ifw.binaries/meta/package.xml
dist/packages/org.qtproject.ifw/meta/package.xml
installerfw.pri
Change-Id: Ia5dd8dfbaa2289f1b167191d6997a5f4340721a2
Diffstat (limited to 'examples/doc/quit_installer.qdoc')
-rw-r--r-- | examples/doc/quit_installer.qdoc | 40 |
1 files changed, 39 insertions, 1 deletions
diff --git a/examples/doc/quit_installer.qdoc b/examples/doc/quit_installer.qdoc index bb1655ad2..c73dddd48 100644 --- a/examples/doc/quit_installer.qdoc +++ b/examples/doc/quit_installer.qdoc @@ -30,11 +30,49 @@ \ingroup qtifwexamples \title Quit Installer Example - \brief Quitting an installer by using a script. + \image qtifw-examples-quit_installer.png + + \brief Using a component script to quit an installer. + + \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> element is set to \c true to preselect the + component in the installer. + \li The \c <Script> element 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 */ |