diff options
Diffstat (limited to 'doc/scripting-api/gui.qdoc')
-rw-r--r-- | doc/scripting-api/gui.qdoc | 30 |
1 files changed, 28 insertions, 2 deletions
diff --git a/doc/scripting-api/gui.qdoc b/doc/scripting-api/gui.qdoc index 63a76b60b..b9e6c1b5f 100644 --- a/doc/scripting-api/gui.qdoc +++ b/doc/scripting-api/gui.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2022 The Qt Company Ltd. +** Copyright (C) 2024 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Installer Framework. @@ -126,9 +126,35 @@ */ /*! + \qmlmethod void gui::setWizardPageButtonText(int pageId, int buttonId, string buttonText) + + Sets \a buttonText for button specified by \a buttonId to a installer page \a pageId. + + \note In some pages, installer will change the button text when entering + the page. In that case, you need to connect to \c entered() -signal of the + page to change the \a buttonText. + + \code + function Component() + { + var page = gui.pageByObjectName("FinishedPage"); + page.entered.connect(Component.prototype.finishPageEntered); + } + Component.prototype.finishPageEntered = function() + { + gui.setWizardPageButtonText(QInstaller.InstallationFinished, buttons.CommitButton, "Commit"); + } + \endcode +*/ + +/*! \qmlmethod void gui::showSettingsButton(boolean show) - Shows the \uicontrol Settings button if \a show is \c true. + Shows the \uicontrol Settings button if \a show is \c true. This function + overrides the visibility of the \uicontrol Settings button in all pages. Be + careful when showing the settings button so that users cannot change network + settings while downloading data in the background. Changing the + settings will restart the wizard and switch back to the introduction page. */ /*! |