blob: 2d242f6aac95493c4c87730a2f77d4a6c7f1e814 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/****************************************************************************
**
** Copyright (C) 2016 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 registerfileextension
\ingroup qtifwexamples
\title Register File Extension Example
\brief Using a component script to register a filename extension on Windows.
\image qtifw-examples-registerfileextension.png
\e{Register File Extension} illustrates how to register a file type on
Windows. We use the \c component.addOperation() function with the
\c RegisterFileType operation to register a randomly generated file type to
be opened with Notepad.
\include installerfw-examples-configuring.qdocinc
\quotefile registerfileextension/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 names of the
installer pages (.ui files) to use.
\endlist
\quotefile registerfileextension/packages/org.qtproject.ifw.example.registerfileextension/meta/package.xml
\section1 Registering File Extensions
In installscript.qs, we call the \c Component() function to connect to the
\c addRegisterFileCheckBox signal as soon as all components have been
loaded:
\quotefromfile registerfileextension/packages/org.qtproject.ifw.example.registerfileextension/meta/installscript.qs
\skipto Component()
\printuntil addRegisterFileCheckBox
We use the \c addRegisterFileCheckBox() function to display a check box for
registering the generated file type on the last page of the installer.
We hide the page when updating and uninstalling:
\skipto addRegisterFileCheckBox
\printuntil )
\skipto isInstaller()
\printuntil /^\}/
We connect to the \c openRegisteredFileIfChecked signal when end users
select \uicontrol Finish on the last installer page:
\quotefromfile registerfileextension/packages/org.qtproject.ifw.example.registerfileextension/meta/installscript.qs
\skipto openRegisteredFileIfChecked
\printuntil ;
We call the \c openRegisteredFileIfChecked function to check that the
file type was successfully registered:
\skipto openRegisteredFileIfChecked
\printuntil /^\}/
We bind the \c unusualFileType variable to the \c generateUnusualFileType()
function that randomly generates a file type with the specified length:
\quotefromfile registerfileextension/packages/org.qtproject.ifw.example.registerfileextension/meta/installscript.qs
\skipto generateUnusualFileType
\printuntil randomString
\printuntil }
We use the \c RegisterFileType operation to create a file of the
specified type and to specify the application to open the file with:
\quotefromfile registerfileextension/packages/org.qtproject.ifw.example.registerfileextension/meta/installscript.qs
\skipto component.createOperations()
\printuntil /^\}/
\include installerfw-examples-generating.qdocinc
After running the installer, double-click the installed file,
\c registeredfile.<extension>, to open it in Notepad.
*/
|
