mirror of
https://github.com/QuasarApp/installer-framework.git
synced 2025-04-26 21:54:31 +00:00
c7066c9dc2
Replace deprecated Q_OS_OSX macro used in several places with the newer Q_OS_MACOS. Old style reference of Apple's desktop operating system name as "OS X" in documentation and files are also replaced with "macOS" where applicable. Task-number: QTIFW-1406 Change-Id: I0561d5e0d964917ac4fca0702d58a06b85d30e57 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
118 lines
4.5 KiB
Plaintext
118 lines
4.5 KiB
Plaintext
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2017 The Qt Company Ltd.
|
|
** Contact: http://www.qt.io/licensing/
|
|
**
|
|
** This file is part of the Qt Installer Framework.
|
|
**
|
|
** $QT_BEGIN_LICENSE:FDL$
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
|
** and conditions see http://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at http://www.qt.io/contact-us.
|
|
**
|
|
** GNU Free Documentation License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU Free
|
|
** Documentation License version 1.3 as published by the Free Software
|
|
** Foundation and appearing in the file included in the packaging of
|
|
** this file. Please review the following information to ensure
|
|
** the GNU Free Documentation License version 1.3 requirements
|
|
** will be met: http://www.gnu.org/copyleft/fdl.html.
|
|
** $QT_END_LICENSE$
|
|
**
|
|
****************************************************************************/
|
|
|
|
/*!
|
|
\example dynamicpage
|
|
\ingroup qtifwexamples
|
|
\title Dynamic Page Installer Example
|
|
|
|
\brief Using a component script and dynamic pages to build an installer.
|
|
|
|
\image qtifw-examples-dynamicpages.png
|
|
|
|
\e{Dynamic Page Installer} illustrates how to use the
|
|
\c component.loaded.connect() function to load custom installer pages (.ui)
|
|
instead of using the default installer pages and how to add functionality to
|
|
the pages.
|
|
|
|
The \uicontrol {Select Installation Type} page contains icons that are added
|
|
to a Qt resource file (.qrc) for delivery with the installer.
|
|
|
|
\include installerfw-examples-configuring.qdocinc
|
|
|
|
\quotefile dynamicpage/config/config.xml
|
|
|
|
\include installerfw-examples-packaging.qdocinc
|
|
|
|
\list
|
|
\li The \c <Script> element specifies the file name of the JavaScript
|
|
file that is loaded to perform operations.
|
|
\li The \c <UserInterfaces> element specifies the file names of the
|
|
installer pages (.ui files) to use.
|
|
\li The \c <Name> element provides domain-like identification for the
|
|
component.
|
|
\endlist
|
|
|
|
\quotefile dynamicpage/packages/org.qtproject.ifw.example.dynamicpage/meta/package.xml
|
|
|
|
This installer contains three components that each have their own package
|
|
information file with slightly different contents.
|
|
|
|
\section1 Creating Dynamic Pages
|
|
|
|
In installscript.js, we create the installer pages and add functionality to
|
|
them.
|
|
|
|
Qt Installer Framework calls the constructors of all scripts. When all the
|
|
constructors are finished and all UI files are loaded, a \c loaded signal is
|
|
emitted for each component.
|
|
|
|
To create an installer page, we have to wait for the \c loaded signal that
|
|
tells us that the UI file has been loaded:
|
|
|
|
\quotefromfile dynamicpage/packages/org.qtproject.ifw.example.dynamicpage/meta/installscript.js
|
|
\skipto component.loaded
|
|
\printuntil ;
|
|
|
|
We hide the default pages by setting their visibility to \c false:
|
|
|
|
\skipto setDefaultPageVisible
|
|
\printuntil ReadyForInstallation
|
|
|
|
We use the \c loaded function that we connected earlier to add functionality
|
|
to the dynamic installer pages:
|
|
|
|
\skipto installerLoaded
|
|
\printuntil defaultInstall.checked
|
|
\printuntil }
|
|
\dots
|
|
|
|
\l installer::addWizardPage() registers a new page to the installer. \l gui::pageWidgetByObjectName()
|
|
is then used to retrieve the root widget of the new page, with its name being \c "Dynamic" + the object
|
|
name of the root widget as set in the .ui file.
|
|
|
|
\section1 Generating the Example Installer
|
|
|
|
To create the example installer, switch to the example source directory on
|
|
the command line and enter the following command:
|
|
|
|
\list
|
|
\li On Windows:
|
|
\code
|
|
..\..\bin\binarycreator.exe -c config\config.xml -r resources/additional.qrc -p packages installer.exe
|
|
\endcode
|
|
\li On Linux or macOS:
|
|
\code
|
|
../../bin/binarycreator -c config/config.xml -r resources/additional.qrc -p packages installer
|
|
\endcode
|
|
\endlist
|
|
|
|
Because the installer uses additional resources, you must give the
|
|
\c {-r} option and specify the path to the Qt resource file that contains
|
|
the resources. The installer is created in the current directory.
|
|
*/
|