installer-framework/examples/doc/openreadme.qdoc
Arttu Tarkiainen c7066c9dc2 Update usage of Apple-related terminology
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>
2019-08-16 08:35:19 +00:00

88 lines
3.3 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 openreadme
\ingroup qtifwexamples
\title Open ReadMe Example
\brief Using a component script to add a check box for opening the readme
file to the final installer page.
\image qtifw-examples-openreadme.png
\e{Open ReadMe} illustrates how to use the \c 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.
\include installerfw-examples-configuring.qdocinc
\quotefile openreadme/config/config.xml
\include installerfw-examples-packaging.qdocinc
\list
\li The \c <Default> element is set to \c true to preselect the
component in the installer.
\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 name of the
installer page (.ui file) to use.
\endlist
\quotefile openreadme/packages/or.qtproject.ifw.example.openreadme/meta/package.xml
\section1 Opening Files After Installation
In installscript.qs, we use the \c Component() function to connect to the
\c installationFinishedPageIsShown signal when the installation is complete
and to the \c installationFinished signal when the end users click
\uicontrol Finish (\uicontrol Done on macOS):
\quotefromfile openreadme/packages/or.qtproject.ifw.example.openreadme/meta/installscript.qs
\skipto Component()
\printuntil }
We call the component::createOperations() function to override the default
method for creating operations:
\printuntil }
If the installation is successful, we call the installer::addWizardPageItem()
function to replace the last installer page with a custom page that contains
the \uicontrol {OpenReadMe} check box:
\printuntil /^\}/
We set the \c readMeCheckBox to \c checked by default and use the
QDesktopServices::openURL() function to open the readme file:
\printuntil /^\}/
\include installerfw-examples-generating.qdocinc
*/