summaryrefslogtreecommitdiffstats
path: root/src/corelib/doc/src/cmake-macros.qdoc
blob: d595208449d511c2dc80870eaf41b8982176b77f (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
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $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 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.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
\page qtcore-cmake-qt5-wrap-cpp.html
\ingroup cmake-macros-qtcore

\title qt5_wrap_cpp

\brief Creates \c{.moc} files from sources.

\section1 Synopsis

\badcode
qt5_wrap_cpp(<VAR> src_file1 [src_file2 ...]
             [TARGET target]
             [OPTIONS ...]
             [DEPENDS ...])
\endcode

\section1 Description

\include includes/qt_wrap_cpp.qdocinc description

\note For compatibility with Qt 6, the command is also available under the name \l qt_wrap_cpp.

\section1 Arguments

\include includes/qt_wrap_cpp.qdocinc arguments

\section1 Examples

\snippet cmake-macros/examples.cmake qt5_wrap_cpp
*/

/*!
\page qtcore-cmake-qt-wrap-cpp.html
\ingroup cmake-macros-qtcore

\title qt_wrap_cpp

\brief Creates \c{.moc} files from sources.

\section1 Synopsis

\badcode
qt_wrap_cpp(<VAR> src_file1 [src_file2 ...]
            [TARGET target]
            [OPTIONS ...]
            [DEPENDS ...])
\endcode

\section1 Description

\include includes/qt_wrap_cpp.qdocinc description

This command was introduced in Qt 5.15. You can use \l qt5_wrap_cpp in older versions of Qt.

\section1 Arguments

\include includes/qt_wrap_cpp.qdocinc arguments

\section1 Examples

\snippet cmake-macros/examples.cmake qt_wrap_cpp
*/

/*!
\page qtcore-cmake-qt5-add-resources.html
\ingroup cmake-macros-qtcore

\title qt5_add_resources

\brief Compiles binary resources into source code.

\section1 Synopsis

\badcode
qt5_add_resources(<VAR> file1.qrc [file2.qrc ...]
                  [OPTIONS ...])
\endcode

\section1 Description

\include includes/qt_add_resources.qdocinc arguments

For embedding bigger resources, see \l qt5_add_big_resources.

\note For compatibility with Qt 6, the command is also available under the name \l qt_add_resources.

\section1 Arguments

\include includes/qt_add_resources.qdocinc arguments

\section1 Examples

\snippet cmake-macros/examples.cmake qt5_add_resources
*/

/*!
\page qtcore-cmake-qt-add-resources.html
\ingroup cmake-macros-qtcore

\title qt_add_resources

\brief Compiles binary resources into source code.

\section1 Synopsis

\badcode
qt_add_resources(<VAR> file1.qrc [file2.qrc ...]
                  [OPTIONS ...])
\endcode

\section1 Description

\include includes/qt_add_resources.qdocinc arguments

For embedding bigger resources, see \l qt_add_big_resources.

This command was introduced in Qt 5.15. You can use \l qt5_add_resources in older versions of Qt.

\section1 Arguments

\include includes/qt_add_resources.qdocinc arguments

\section1 Examples

\snippet cmake-macros/examples.cmake qt_add_resources
*/

/*!
\page qtcore-cmake-qt5-add-big-resources.html
\ingroup cmake-macros-qtcore

\title qt5_add_big_resources

\brief Compiles big binary resources into object code.

\section1 Synopsis

\badcode
qt5_add_big_resources(<VAR> file1.qrc [file2.qrc ...]
                      [OPTIONS ...])
\endcode

\section1 Description

\include includes/qt_add_big_resources.qdocinc description

\note For compatibility with Qt 6, the command is also available under the name \l qt_add_big_resources.

\section1 Arguments

\include includes/qt_add_big_resources.qdocinc arguments

\section1 Examples

\snippet cmake-macros/examples.cmake qt5_add_big_resources
*/

/*!
\page qtcore-cmake-qt-add-big-resources.html
\ingroup cmake-macros-qtcore

\title qt_add_big_resources

\brief Compiles big binary resources into object code.

\section1 Synopsis

\badcode
qt_add_big_resources(<VAR> file1.qrc [file2.qrc ...]
                     [OPTIONS ...])
\endcode

\section1 Description

\include includes/qt_add_big_resources.qdocinc description

This command was introduced in Qt 5.15. You can use \l qt5_add_big_resources in older versions of Qt.

\section1 Arguments

\include includes/qt_add_big_resources.qdocinc arguments

\section1 Examples

\snippet cmake-macros/examples.cmake qt_add_big_resources
*/

/*!
\page qtcore-cmake-qt5_add_binary_resources.html
\ingroup cmake-macros-qtcore

\title qt5_add_binary_resources

\brief Creates an \c{RCC} file from a list of Qt resource files.

\section1 Synopsis

\badcode
qt5_add_binary_resources(target file1.qrc [file2.qrc ...]
                         [DESTINATION ...]
                         [OPTIONS ...])
\endcode

\section1 Description

\include includes/qt_add_binary_resources.qdocinc description

\note For compatibility with Qt 6, the command is also available under the name \l qt_add_binary_resources.

\section1 Arguments

\include includes/qt_add_binary_resources.qdocinc arguments

\section1 Examples

\snippet cmake-macros/examples.cmake qt5_add_binary_resources
*/

/*!
\page qtcore-cmake-qt_add_binary_resources.html
\ingroup cmake-macros-qtcore

\title qt_add_binary_resources

\brief Creates an \c{RCC} file from a list of Qt resource files.

\section1 Synopsis

\badcode
qt_add_binary_resources(target file1.qrc [file2.qrc ...]
                        [DESTINATION ...]
                        [OPTIONS ...])
\endcode

\section1 Description

\include includes/qt_add_binary_resources.qdocinc description

This command was introduced in Qt 5.15. You can use \l qt5_add_binary_resources in older versions of Qt.

\section1 Arguments

\include includes/qt_add_binary_resources.qdocinc arguments

\section1 Examples

\snippet cmake-macros/examples.cmake qt_add_binary_resources
*/

/*!
\page qtcore-cmake-qt5-generate-moc.html
\ingroup cmake-macros-qtcore

\title qt5_generate_moc

\brief Calls moc on an input file.

\section1 Synopsis

\badcode
qt5_generate_moc(src_file dest_file
                 [TARGET target])
\endcode

\section1 Description

\include includes/qt_generate_moc.qdocinc description

\note For compatibility with Qt 6, the command is also available under the name \l qt_generate_moc.

\section1 Arguments

\include includes/qt_generate_moc.qdocinc arguments

\section1 Examples

\snippet cmake-macros/examples.cmake qt5_generate_moc
*/

/*!
\page qtcore-cmake-qt-generate-moc.html
\ingroup cmake-macros-qtcore

\title qt_generate_moc

\brief Calls moc on an input file.

\section1 Synopsis

\badcode
qt_generate_moc(src_file dest_file
                [TARGET target])
\endcode

\section1 Description

\include includes/qt_generate_moc.qdocinc description

This command was introduced in Qt 5.15. You can use \l qt5_generate_moc in older versions of Qt.

\section1 Arguments

\include includes/qt_generate_moc.qdocinc arguments

\section1 Examples

\snippet cmake-macros/examples.cmake qt_generate_moc
*/

/*!
\page qtcore-cmake-qt5-import-plugins.html
\ingroup cmake-macros-qtcore

\title qt5_import_plugins

\brief Specifies a custom set of plugins to import for a static Qt build

\section1 Synopsis

\badcode
qt5_import_plugins(target
                   [INCLUDE plugin ...]
                   [EXCLUDE plugin ...]
                   [INCLUDE_BY_TYPE plugin_type plugin ...]
                   [EXCLUDE_BY_TYPE plugin_type])
\endcode

\section1 Description

\include includes/qt_import_plugins.qdocinc description

\note For compatibility with Qt 6, the command is also available under the name \l qt_import_plugins.

\section1 Examples

\snippet cmake-macros/examples.cmake qt5_import_plugins

In the snippet above, the following occurs with the executable \c myapp:

\list
\li The \c Qt5::QCocoaIntegrationPlugin is imported into myapp.
\li The \c Qt5::QMinimalIntegrationPlugin plugin is
    excluded from being automatically imported into myapp.
\li The default list of plugins for \c imageformats is
    overridden to only include Qt5::QGifPlugin and Qt5::QJpegPlugin.
\li All \c sqldrivers plugins are excluded from automatic importing.
\endlist
*/

/*!
\page qtcore-cmake-qt-import-plugins.html
\ingroup cmake-macros-qtcore

\title qt_import_plugins

\brief Specifies a custom set of plugins to import for a static Qt build

\section1 Synopsis

\badcode
qt_import_plugins(target
                  [INCLUDE plugin ...]
                  [EXCLUDE plugin ...]
                  [INCLUDE_BY_TYPE plugin_type plugin ...]
                  [EXCLUDE_BY_TYPE plugin_type])
\endcode

\section1 Description

\include includes/qt_import_plugins.qdocinc description

This command was introduced in Qt 5.15. You can use \l qt5_import_plugins in older versions of Qt.

\section1 Examples

\snippet cmake-macros/examples.cmake qt_import_plugins

In the snippet above, the following occurs with the executable \c myapp:

\list
\li The \c Qt5::QCocoaIntegrationPlugin is imported into myapp.
\li The \c Qt5::QMinimalIntegrationPlugin plugin is
    excluded from being automatically imported into myapp.
\li The default list of plugins for \c imageformats is
    overridden to only include Qt5::QGifPlugin and Qt5::QJpegPlugin.
\li All \c sqldrivers plugins are excluded from automatic importing.
\endlist
*/