diff options
| author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-01-19 16:46:35 +0100 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-01-22 11:03:38 +0100 |
| commit | ed7e4ef5cd4442f3f02169e15f7977a6cd0c7f53 (patch) | |
| tree | 523edcea314b1818c3beff9cd07593b7dd1f5f94 /src/libs/installer/scriptengine.cpp | |
| parent | 0b9c0b380290d1b817286f6ae6dd3b2ce82d487f (diff) | |
Doc: add docs for the gui JavaScript object
Based on the example code in the Manual.
Change-Id: I4b933fe49768fe296c89d715ea5aef30b6e3430b
Reviewed-by: Jarek Kobus <jaroslaw.kobus@theqtcompany.com>
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
Diffstat (limited to 'src/libs/installer/scriptengine.cpp')
| -rw-r--r-- | src/libs/installer/scriptengine.cpp | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/src/libs/installer/scriptengine.cpp b/src/libs/installer/scriptengine.cpp index d08ddbc0a..85b9be79f 100644 --- a/src/libs/installer/scriptengine.cpp +++ b/src/libs/installer/scriptengine.cpp @@ -220,6 +220,7 @@ namespace QInstaller { /*! \qmltype gui \inqmlmodule scripting + \brief Enables interaction with the installer UI. */ /*! @@ -272,6 +273,9 @@ void GuiProxy::setPackageManagerGui(PackageManagerGui *gui) /*! \qmlmethod object gui::pageById(int id) + + Returns the installer page specified by \a id. The values of \c id for the + available installer pages are provided by QInstaller::WizardPage. */ QJSValue GuiProxy::pageById(int id) const { @@ -282,6 +286,9 @@ QJSValue GuiProxy::pageById(int id) const /*! \qmlmethod object gui::pageByObjectName(string name) + + Returns the installer page specified by \a name. The value of \c name is the + object name set in the UI file that defines the installer page. */ QJSValue GuiProxy::pageByObjectName(const QString &name) const { @@ -292,6 +299,8 @@ QJSValue GuiProxy::pageByObjectName(const QString &name) const /*! \qmlmethod object gui::currentPageWidget() + + Returns the current wizard page. */ QJSValue GuiProxy::currentPageWidget() const { @@ -322,6 +331,9 @@ QString GuiProxy::defaultButtonText(int wizardButton) const /*! \qmlmethod void gui::clickButton(int wizardButton, int delayInMs) + + Automatically clicks the button specified by \a wizardButton after a delay + in milliseconds specified by \a delayInMs. */ void GuiProxy::clickButton(int wizardButton, int delayInMs) { |