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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
/*!
\page quick-converting-ui-projects.html
\if defined(qtdesignstudio)
\previouspage studio-porting-projects.html
\nextpage creator-editor-external.html
\else
\previouspage qtquick-iso-icon-browser.html
\nextpage creator-using-qt-designer.html
\endif
\title Converting UI Projects to Applications
Qt Quick UI projects are useful for creating user interfaces. To
use them for application development in Qt Creator you have to add:
\list
\li Project configuration file (.pro)
\li C++ code (.cpp)
\li Resource files (.qrc)
\li Code needed for deploying applications to \l{glossary-device}
{devices}
\endlist
For more information about integrating QML and C++, see
\l{https://doc.qt.io/qt/qtqml-cppintegration-overview.html}
{Overview - QML and C++ Integration}.
You can use a Qt Creator wizard template to create a Qt Quick application
that is built using the qmake build system and then copy the source files
from the Qt UI Quick project to the application project.
You can use the \c RESOURCES option in the project configuration file to
automatically add all the QML files and related assets to a
\l{The Qt Resource System}{Qt resource collection file (.qrc)}. However,
large files should be included as external binary resources instead of
compiling them into the binary.
The wizard automatically adds the \c QML_IMPORT_PATH option to the project
file for specifying the required
\l{https://doc.qt.io/qt/qtqml-syntax-imports.html#qml-import-path}
{QML import path}. The path is only needed if more than one subdirectory
contains QML files.
Then you can use the \l QQuickView class in the main C++ source file to
show the main QML file when the application starts.
The \e {Qt Quick Designer Components} module is installed when you
install \QDS. If you use Qt Quick Studio Components or Effects
from the module in a project that you want to edit in Qt Creator,
you have to build the module and install it to your Qt to be able to
build your project. For more information, see
\l{Adding Qt Quick Designer Components to Qt Installations}.
The \l{Qt Quick Timeline} module is installed when you install \QDS.
If you only install Qt Creator and Qt, remember to also select the
Qt Quick Timeline module for installation. If your Qt is older than
5.14, you must build the Qt Quick Timeline module and install it to
your Qt to be able to build your project. For more information, see
\l{Adding Qt Quick Timeline Module to Qt Installations}.
\section1 Converting Projects
To convert a project that has a .qmlproject file to one that has a .pro
file:
\list 1
\li Select \uicontrol File > \uicontrol {New File or Project} >
\uicontrol {Application (Qt Quick)} >
\uicontrol {Qt Quick Application - Empty} > \uicontrol Choose.
\li In the \uicontrol {Build system} field, select \l qmake as the build
system to use for building and running the project, and then select
\uicontrol Next (or \uicontrol Continue on \macos).
\li Follow the instructions of the wizard to create the project.
\li In the file explorer, copy the source files from the Qt Quick UI
project directory to a subdirectory in the application
project directory. For the purpose of these instructions, the
directory is called \c qml.
\li Open the application project file, and edit the value of the
\c RESOURCES option to add the following line:
\badcode
RESOURCES += \
$$files(qml/*)
\endcode
\li Also edit the value of the \c QML_IMPORT_PATH option to specify the
QML import path:
\badcode
QML_IMPORT_PATH = qml/imports
\endcode
Where \c {qml/imports} is the import path.
\li Select \uicontrol Build > \uicontrol {Run qmake} to apply the
\c RESOURCES option to the build configuration.
\li Open the \e {main.cpp} file and replace the QQmlApplicationEngine
object with a QQuickView object:
\quotefromfile progressbar/main.cpp
\skipto QQuickView view;
\printuntil view.show()
Where \c {qrc:/qml/imports} is the import path and
\c {qrc:/qml/ProgressBar.ui.qml} is the path to and the
name of the main QML file in the Qt Quick UI project.
\li Select \uicontrol Build > \uicontrol Run to build and run your
project.
\endlist
For example, if you copy the source files of the \e ProgressBar
example from your \QDS installation (located in the
\c{\share\qtcreator\examples\ProgressBar} directory) to an empty
Qt Quick application project and make the necessary changes, the
\e {main.cpp} file should look as follows:
\quotefile progressbar/main.cpp
\section1 Handling Large Data Files
Graphical assets used in the UI, such as images, effects, or 3D scenes
are a typical cause for performance problems in UIs. Even building the
application requires huge amounts of memory if you try to include large
asset files, such as 100-MB 3D models or 64-MB textures, into the \c .qrc
file for compiling them into the binary.
First try to optimize your assets, as described in \l{Optimizing Designs}
and \l {Creating Optimized 3D Scenes}.
If you really need large assets, they should either be loaded directly from
the file system or use the Qt resource system in the dynamic way. For more
information, see \l{The Qt Resource System} in the Qt documentation.
\section1 Adding Custom Fonts
To \l{Using Custom Fonts}{use custom fonts} from the Qt Quick UI project,
call the QFontDatabase::addApplicationFont() function from the \e {main.cpp}
file.
\section1 Adding Qt Quick Designer Components to Qt Installations
If you use Qt Quick Studio Components or Effects in your project, you have
to check out and install the \e {Qt Quick Designer Components} module from
\l{https://codereview.qt-project.org/admin/repos/qt-labs/qtquickdesigner-components}
{Qt Code Review}.
For example:
\badcode
git clone "https://codereview.qt-project.org/qt-labs/qtquickdesigner-components"
\endcode
Then use qmake from your Qt installation to build the module and to add it
to your Qt. Switch to the directory that contains the sources (usually,
qtquickdesigner-components), and enter the following commands:
\badcode
<path_to_qmake>\qmake -r
make
make install
\endcode
On Windows, use the \c nmake and \c {nmake install} commands instead.
\section1 Adding Qt Quick Timeline Module to Qt Installations
\note You only need to do this if your Qt version is older than 5.14.
Check out the \l{Qt Quick Timeline} module from
\l{https://codereview.qt-project.org/#/admin/projects/qt/qtquicktimeline}
{Qt Code Review}.
For example:
\badcode
git clone "https://codereview.qt-project.org/qt/qtquicktimeline"
\endcode
To use qmake, you need to check out a branch or tag that contains the
qmake configuration files.
For example:
\badcode
git checkout v5.15.2
\endcode
Then build the module and add it to your Qt as described in the previous
section.
*/
|
