《Qt5+安装包制作（Qt Installer Framework）》五--gui

超、凢脫俗 2022-09-08 11:55 150阅读 0赞

# gui #

Enables interaction with the installer UI. [More...][]

*  [List of all members, including inherited members][List of all members_ including inherited members]

## Signals ##

*  **[finishButtonClicked][]**()
 *  **[gotRestarted][]**()
 *  **[interrupted][]**()
 *  **[languageChanged][]**()
 *  **[settingsButtonClicked][]**()

## Methods ##

*  void **[cancelButtonClicked][]**()
 *  void **[clickButton][]**(string *objectName*, int *delayInMs*)
 *  void **[clickButton][clickButton 1]**(int *wizardButton*, int *delayInMs*)
 *  object **[currentPageWidget][]**()
 *  string **[defaultButtonText][]**(int *wizardButton*)
 *  object **[findChild][]**(object *parent*, string *objectName*)
 *  object\[\] **[findChildren][]**(object *parent*, string *objectName*)
 *  boolean **[isButtonEnabled][]**(int *wizardButton*)
 *  object **[pageById][]**(int *id*)
 *  object **[pageByObjectName][]**(string *name*)
 *  **object [pageWidgetByObjectName][](string *name*)**
 *  void **[reject][]**()
 *  void **[rejectWithoutPrompt][]**()
 *  void **[setModified][]**(boolean *value*)
 *  void **[setSettingsButtonEnabled][]**(boolean *enable*)
 *  void **[setTextItems][]**(object *control*, stringlist *items*)
 *  void **[showFinishedPage][]**()
 *  void **[showSettingsButton][]**(boolean *show*)

## Detailed Description ##

## Signal Documentation ##

<table> 
 <tbody> 
  <tr> 
   <td> <p>finishButtonClicked()</p> </td> 
  </tr> 
 </tbody> 
</table>

This signal is emitted when the **Finish** button is clicked.

**Note: **The corresponding handler is `onFinishButtonClicked`.

<table> 
 <tbody> 
  <tr> 
   <td> <p>gotRestarted()</p> </td> 
  </tr> 
 </tbody> 
</table>

This signal is emitted when the installer is restarted.

**Note: **The corresponding handler is `onGotRestarted`.

<table> 
 <tbody> 
  <tr> 
   <td> <p>interrupted()</p> </td> 
  </tr> 
 </tbody> 
</table>

This signal is emitted when the end user chooses to cancel the installation and quit the installer.

**Note: **The corresponding handler is `onInterrupted`.

<table> 
 <tbody> 
  <tr> 
   <td> <p>languageChanged()</p> </td> 
  </tr> 
 </tbody> 
</table>

This signal is emitted when the application language changes.

**Note: **The corresponding handler is `onLanguageChanged`.

<table> 
 <tbody> 
  <tr> 
   <td> <p>settingsButtonClicked()</p> </td> 
  </tr> 
 </tbody> 
</table>

This signal is emitted when the **Settings** button is clicked.

**Note: **The corresponding handler is `onSettingsButtonClicked`.

## Method Documentation ##

<table> 
 <tbody> 
  <tr> 
   <td> <p>void&nbsp;cancelButtonClicked()</p> </td> 
  </tr> 
 </tbody> 
</table>

Asks end users whether they want to cancel the operation and quit the installer, uninstaller, or package manager.

<table> 
 <tbody> 
  <tr> 
   <td> <p>void&nbsp;clickButton(<a href="http://doc.qt.io/qt-5/qml-string.html" rel="nofollow">string</a>&nbsp;<em>objectName</em>,&nbsp;<a href="http://doc.qt.io/qt-5/qml-int.html" rel="nofollow">int</a>&nbsp;<em>delayInMs</em>)</p> </td> 
  </tr> 
 </tbody> 
</table>

Automatically clicks the button specified by *objectName* after a delay in milliseconds specified by *delayInMs*.

<table> 
 <tbody> 
  <tr> 
   <td> <p>void&nbsp;clickButton(<a href="http://doc.qt.io/qt-5/qml-int.html" rel="nofollow">int</a>&nbsp;<em>wizardButton</em>,&nbsp;<a href="http://doc.qt.io/qt-5/qml-int.html" rel="nofollow">int</a>&nbsp;<em>delayInMs</em>)</p> </td> 
  </tr> 
 </tbody> 
</table>

Automatically clicks the button specified by *wizardButton* after a delay in milliseconds specified by *delayInMs*.

<table> 
 <tbody> 
  <tr> 
   <td> <p>object&nbsp;currentPageWidget()</p> </td> 
  </tr> 
 </tbody> 
</table>

Returns the current wizard page.

<table> 
 <tbody> 
  <tr> 
   <td> <p><a href="http://doc.qt.io/qt-5/qml-string.html" rel="nofollow">string</a>&nbsp;defaultButtonText(<a href="http://doc.qt.io/qt-5/qml-int.html" rel="nofollow">int</a>&nbsp;<em>wizardButton</em>)</p> </td> 
  </tr> 
 </tbody> 
</table>

Returns the default text for the button specified by *wizardButton*.

<table> 
 <tbody> 
  <tr> 
   <td> <p>object&nbsp;findChild(object&nbsp;<em>parent</em>,&nbsp;<a href="http://doc.qt.io/qt-5/qml-string.html" rel="nofollow">string</a>&nbsp;<em>objectName</em>)</p> </td> 
  </tr> 
 </tbody> 
</table>

Returns the first descendant of *parent* that has *objectName* as name.

**See also **[QObject::findChild][QObject_findChild].

<table> 
 <tbody> 
  <tr> 
   <td> <p>object[]&nbsp;findChildren(object&nbsp;<em>parent</em>,&nbsp;<a href="http://doc.qt.io/qt-5/qml-string.html" rel="nofollow">string</a>&nbsp;<em>objectName</em>)</p> </td> 
  </tr> 
 </tbody> 
</table>

Returns all descendants of *parent* that have *objectName* as name.

**See also **[QObject::findChildren][QObject_findChildren].

<table> 
 <tbody> 
  <tr> 
   <td> <p>boolean&nbsp;isButtonEnabled(<a href="http://doc.qt.io/qt-5/qml-int.html" rel="nofollow">int</a>&nbsp;<em>wizardButton</em>)</p> </td> 
  </tr> 
 </tbody> 
</table>

Returns `true` if the button specified by *wizardButton* is enabled. Returns `false` if a button of the specified type is not found.

<table> 
 <tbody> 
  <tr> 
   <td> <p>object&nbsp;pageById(<a href="http://doc.qt.io/qt-5/qml-int.html" rel="nofollow">int</a>&nbsp;<em>id</em>)</p> </td> 
  </tr> 
 </tbody> 
</table>

Returns the installer page specified by *id*. The values of `id` for the available installer pages are provided by [QInstaller::WizardPage][QInstaller_WizardPage].

<table> 
 <tbody> 
  <tr> 
   <td> <p>object&nbsp;pageByObjectName(<a href="http://doc.qt.io/qt-5/qml-string.html" rel="nofollow">string</a>&nbsp;<em>name</em>)</p> </td> 
  </tr> 
 </tbody> 
</table>

Returns the installer page specified by *name*. The value of `name` is the object name set in the UI file that defines the installer page.

<table> 
 <tbody> 
  <tr> 
   <td> <p><strong><span style="color:#fe2c24;"><span style="background-color:#fefcd8;">object&nbsp;pageWidgetByObjectName(</span></span><a href="http://doc.qt.io/qt-5/qml-string.html" rel="nofollow"><span style="color:#fe2c24;"><span style="background-color:#fefcd8;">string</span></span></a><span style="color:#fe2c24;"><span style="background-color:#fefcd8;">&nbsp;</span><em><span style="background-color:#fefcd8;">name</span></em><span style="background-color:#fefcd8;">)</span></span></strong></p> </td> 
  </tr> 
 </tbody> 
</table>

**For dynamic pages, returns the widget specified by *name* read from the UI file.**

<table> 
 <tbody> 
  <tr> 
   <td> <p>void&nbsp;reject()</p> </td> 
  </tr> 
 </tbody> 
</table>

Quits the installer, uninstaller, or package manager.

<table> 
 <tbody> 
  <tr> 
   <td> <p>void&nbsp;rejectWithoutPrompt()</p> </td> 
  </tr> 
 </tbody> 
</table>

Quits the installer, uninstaller, or package manager without asking end users for confirmation.

<table> 
 <tbody> 
  <tr> 
   <td> <p>void&nbsp;setModified(boolean&nbsp;<em>value</em>)</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td> <p>void&nbsp;setSettingsButtonEnabled(boolean&nbsp;<em>enable</em>)</p> </td> 
  </tr> 
 </tbody> 
</table>

Enables the **Settings** button by setting *enable* to `true`.

<table> 
 <tbody> 
  <tr> 
   <td> <p>void&nbsp;setTextItems(object&nbsp;<em>control</em>,&nbsp;stringlist&nbsp;<em>items</em>)</p> </td> 
  </tr> 
 </tbody> 
</table>

Updates the model of *control* (which must be a [QComboBox][] or [QAbstractItemView][]) such that it contains the given *items*.

<table> 
 <tbody> 
  <tr> 
   <td> <p>void&nbsp;showFinishedPage()</p> </td> 
  </tr> 
 </tbody> 
</table>

Shows the InstallationFinished page.

<table> 
 <tbody> 
  <tr> 
   <td> <p>void&nbsp;showSettingsButton(boolean&nbsp;<em>show</em>)</p> </td> 
  </tr> 
 </tbody> 
</table>

Shows the **Settings** button if *show* is `true`.

[More...]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#details
[List of all members_ including inherited members]: https://doc.qt.io/qtinstallerframework/scripting-gui-members.html
[finishButtonClicked]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#finishButtonClicked-signal
[gotRestarted]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#gotRestarted-signal
[interrupted]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#interrupted-signal
[languageChanged]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#languageChanged-signal
[settingsButtonClicked]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#settingsButtonClicked-signal
[cancelButtonClicked]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#cancelButtonClicked-method
[clickButton]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#clickButton-method-1
[clickButton 1]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#clickButton-method
[currentPageWidget]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#currentPageWidget-method
[defaultButtonText]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#defaultButtonText-method
[findChild]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#findChild-method
[findChildren]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#findChildren-method
[isButtonEnabled]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#isButtonEnabled-method
[pageById]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#pageById-method
[pageByObjectName]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#pageByObjectName-method
[pageWidgetByObjectName]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#pageWidgetByObjectName-method
[reject]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#reject-method
[rejectWithoutPrompt]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#rejectWithoutPrompt-method
[setModified]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#setModified-method
[setSettingsButtonEnabled]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#setSettingsButtonEnabled-method
[setTextItems]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#setTextItems-method
[showFinishedPage]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#showFinishedPage-method
[showSettingsButton]: https://doc.qt.io/qtinstallerframework/scripting-gui.html#showSettingsButton-method
[QObject_findChild]: http://doc.qt.io/qt-5/qobject.html#findChild
[QObject_findChildren]: http://doc.qt.io/qt-5/qobject.html#findChildren
[QInstaller_WizardPage]: https://doc.qt.io/qtinstallerframework/scripting-qinstaller.html#WizardPage-prop
[QComboBox]: http://doc.qt.io/qt-5/qcombobox.html
[QAbstractItemView]: http://doc.qt.io/qt-5/qabstractitemview.html