Change Installer UI Example

Using a component script to modify the installer UI.

Change Installer UI demonstrates how to use the Component() function to modify the default text for the check box label on the license check page. This example does not install any components, but we specify a dummy component in the package information file, because installers without components are not allowed.

Configuring the Example Installer

The installer configuration file, config.xml, in the config directory specifies the text and default values used in the installer:

  • The <Name> element specifies the application name that is added to the page name and introduction text.
  • The <Version> element specifies the application version number.
  • The <Title> element specifies the installer name displayed on the title bar.
  • The <Publisher> element specifies the publisher of the software (as shown in the Windows Control Panel, for example).
  • The <StartMenuDir> element specifies the name of the default program group for the product in the Windows Start menu.
  • The <TargetDir> element specifies that the default target directory is located in the IfwExamples directory in the home directory of the current user (because the predefined variable@HomeDir@ is used as a part of the value). For more information, see Predefined Variables.
<?xml version="1.0" encoding="UTF-8"?>
    <Name>Change Installer UI Example</Name>
    <Title>Change Installer UI Example</Title>
    <StartMenuDir>Qt IFW Examples</StartMenuDir>

Creating the Example Package Information File

The installer package information file, package.xml, in the meta directory specifies the components that are available for installation:

  • The <DisplayName> element specifies the human-readable name of the component.
  • The <Description> element specifies the human-readable description of the component.
  • The <Version> element specifies the version number of the component.
  • The <ReleaseDate> element specifies the date when this component version was released.
  • The <Default> element specifies whether the component is preselected for installation in the user interface by default.
  • The <Script> element specifies the file name of the JavaScript file that is loaded to perform operations.
  • The <Licenses> element specifies the name of the license agreement to be accepted by the end user and the filename of the file that contains the license.
<?xml version="1.0" encoding="UTF-8"?>
    <DisplayName>Dummy Component</DisplayName>
    <Description>This example does not install any components. It demonstrates
    modifying the text on the next page.</Description>
        <License name="Beer Public License Agreement" file="license.txt" />

Modifying UI Text

In installscript.qs, we call the Component() function to add the license check page and to connect to the changeLicenseLabels signal when end users enter the page:

function Component()
    if (!installer.isCommandLineInstance())

We use the changeLicenseLabels function to change the text label for the accept license check box on the page:

changeLicenseLabels = function()
    page = gui.pageWidgetByObjectName("LicenseAgreementPage");
    page.AcceptLicenseLabel.setText("Yes I do!");

Note: Do not use the Component() function to add translations.

Generating the Example Installer

To create the example installer, switch to the example source directory on the command line and enter the following command:

  • On Windows:
    ..\..\bin\binarycreator.exe -c config\config.xml -p packages installer.exe
  • On Linux or macOS:
    ../../bin/binarycreator -c config/config.xml -p packages installer

The installer is created in the current directory.


© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. The Qt Company, Qt and their respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.