diff options
| author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-01-12 15:19:57 +0100 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-01-13 13:39:38 +0100 |
| commit | 776a6e0ad39de93009d02bc004f9f879643e3785 (patch) | |
| tree | 607f6d19fd73b8c119eacf3c64ffd0fa1d293c5a /src/libs/installer/scriptengine.cpp | |
| parent | 0c2470682c8c3956767efbcbf37b7ad4ec110550 (diff) | |
Doc: add docs for buttons JavaScript object
Based on Qt 5 QWizard documentation.
Change-Id: Ic61ed428d1513fc21131992b1b40bf63a93b4fd2
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
Reviewed-by: Jarek Kobus <jaroslaw.kobus@theqtcompany.com>
Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
Diffstat (limited to 'src/libs/installer/scriptengine.cpp')
| -rw-r--r-- | src/libs/installer/scriptengine.cpp | 37 |
1 files changed, 26 insertions, 11 deletions
diff --git a/src/libs/installer/scriptengine.cpp b/src/libs/installer/scriptengine.cpp index dff421c77..fb67a1788 100644 --- a/src/libs/installer/scriptengine.cpp +++ b/src/libs/installer/scriptengine.cpp @@ -82,22 +82,37 @@ namespace QInstaller { /*! \qmltype buttons \inqmlmodule scripting + + \brief Provides buttons that can be used on installer pages. + + You can use a set of standard buttons and some custom buttons on the + installer pages. For more information about the buttons used by default on + each installer page, see \l {Controller Scripting}. */ /*! \qmlproperty enumeration buttons::QWizard - \list - \li buttons.BackButton - \li buttons.NextButton - \li buttons.CommitButton - \li buttons.FinishButton - \li buttons.CancelButton - \li buttons.HelpButton - \li buttons.CustomButton1 - \li buttons.CustomButton2 - \li buttons.CustomButton3 - \endlist + Specifies the buttons on an installer page. + + \value buttons.BackButton + The \uicontrol Back button (\uicontrol {Go Back} on OS X.) + \value buttons.NextButton + The \uicontrol Next button (\uicontrol Continue on OS X.) + \value buttons.CommitButton + The \uicontrol Commit button. + \value buttons.FinishButton + The \uicontrol Finish button (\uicontrol Done on OS X.) + \value buttons.CancelButton + The \uicontrol Cancel button. + \value buttons.HelpButton + The \uicontrol Help button. + \value buttons.CustomButton1 + A custom button. + \value buttons.CustomButton2 + A custom button. + \value buttons.CustomButton3 + A custom button. */ /*! |