diff options
| author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2014-12-23 14:59:17 +0100 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-01-09 13:39:01 +0100 |
| commit | 0b8539084cf84ad3e5386341b4a93542a66f1742 (patch) | |
| tree | 16b70908922ec8d81ed5b749e7577f8560a5259c | |
| parent | 9a5127a9d99ba2650e8a1f4c16c82876b7b915f9 (diff) | |
Doc: update docs for the Start Menu example
Change-Id: I861fb5fa80d7467a315c77b903d8de3b58724c54
Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
| -rw-r--r-- | examples/doc/images/qtifw-examples-startmenu.png | bin | 0 -> 15605 bytes | |||
| -rw-r--r-- | examples/doc/startmenu.qdoc | 33 | ||||
| -rw-r--r-- | examples/startmenu/config/config.xml | 4 |
3 files changed, 35 insertions, 2 deletions
diff --git a/examples/doc/images/qtifw-examples-startmenu.png b/examples/doc/images/qtifw-examples-startmenu.png Binary files differnew file mode 100644 index 000000000..f332f2381 --- /dev/null +++ b/examples/doc/images/qtifw-examples-startmenu.png diff --git a/examples/doc/startmenu.qdoc b/examples/doc/startmenu.qdoc index 1c9c98e49..8c8aa46b7 100644 --- a/examples/doc/startmenu.qdoc +++ b/examples/doc/startmenu.qdoc @@ -32,9 +32,42 @@ \brief Adding an entry to the Windows Start menu. + \image qtifw-examples-startmenu.png + + \e{Start Menu} illustrates how to use the \gui Component function to add an + entry for opening a README file to the Windows \uicontrol Start menu. + \include installerfw-examples-configuring.qdocinc \quotefile startmenu/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 startmenu/packages/org.qtproject.ifw.example/meta/package.xml + + \section1 Adding Entries to Start Menu + + In installscript.qs, we use the \c createOperations() function to call the + component::createOperations() function, which creates the \c Extract + operation by default: + + \quotefromfile startmenu/packages/org.qtproject.ifw.example/meta/installscript.qs + \skipto createOperations + \printuntil { + \skipto createOperations + \printuntil ; + + On Windows, we use the component::addOperation function to add a shortcut + to the \uicontrol Start menu for opening the readme file: + + \printuntil /^\}/ + \include installerfw-examples-generating.qdocinc */ diff --git a/examples/startmenu/config/config.xml b/examples/startmenu/config/config.xml index e95445d1b..8da61b26e 100644 --- a/examples/startmenu/config/config.xml +++ b/examples/startmenu/config/config.xml @@ -5,6 +5,6 @@ <Title>Start Menu Shortcut Example</Title> <Publisher>Qt-Project</Publisher> <!-- Directory name is used in component.xml --> - <StartMenuDir>Qt Installer Framework Example</StartMenuDir> - <TargetDir>@HomeDir@/IFWStartMenuExample</TargetDir> + <StartMenuDir>Qt Installer Framework Examples</StartMenuDir> + <TargetDir>@HomeDir@/IfwExample</TargetDir> </Installer> |
