Open ReadMe Example

Using a component script to add a check box for opening the readme file to the final installer page.

Open ReadMe illustrates how to use the Component() function to add a check box to the installation finished page and to open the readme file if end users select the check box.

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>Open Readme Example</Name>
    <Title>Open Readme 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 is set to true to preselect the component in the installer.
  • The <Script> element specifies the file name of the JavaScript file that is loaded to perform operations.
  • The <UserInterfaces> element specifies the file name of the installer page (.ui file) to use.
<?xml version="1.0" encoding="UTF-8"?>
    <DisplayName>Open readme</DisplayName>
    <Description>Show checkbox asking whether to open Readme at the end</Description>

Opening Files After Installation

In installscript.qs, we use the Component() function to connect to the installationFinishedPageIsShown signal when the installation is complete and to the installationFinished signal when the end users click Finish (Done on macOS):

function Component()
    installer.installationFinished.connect(this, Component.prototype.installationFinishedPageIsShown);
    installer.finishButtonClicked.connect(this, Component.prototype.installationFinished);

We call the component::createOperations() function to override the default method for creating operations:

Component.prototype.createOperations = function()

If the installation is successful, we call the installer::addWizardPageItem() function to replace the last installer page with a custom page that contains the OpenReadMe check box:

Component.prototype.installationFinishedPageIsShown = function()
    try {
        if (installer.isInstaller() && installer.status == QInstaller.Success) {
            installer.addWizardPageItem( component, "ReadMeCheckBoxForm", QInstaller.InstallationFinished );
    } catch(e) {

We set the readMeCheckBox to checked by default and use the QDesktopServices::openURL() function to open the readme file:

Component.prototype.installationFinished = function()
    try {
        if (installer.isInstaller() && installer.status == QInstaller.Success) {
            var checkboxForm = component.userInterface( "ReadMeCheckBoxForm" );
            if (checkboxForm && checkboxForm.readMeCheckBox.checked) {
                QDesktopServices.openUrl("file:///" + installer.value("TargetDir") + "/README.txt");
    } catch(e) {

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.


© 2018 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.