-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathQt5-module.html
452 lines (415 loc) · 18.1 KB
/
Qt5-module.html
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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
<!DOCTYPE html>
<html lang="en">
<head>
<base href=".">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Qt5 module</title>
<link rel="stylesheet" href="assets/css/dark-frontend.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/light-frontend.css" type="text/css" title="light">
<link rel="stylesheet" href="assets/css/bootstrap-toc.min.css" type="text/css">
<link rel="stylesheet" href="assets/css/jquery.mCustomScrollbar.min.css">
<link rel="stylesheet" href="assets/js/search/enable_search.css" type="text/css">
<link rel="stylesheet" href="assets/css/notes.css" type="text/css">
<link rel="stylesheet" href="assets/css/prism-tomorrow.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/prism.css" type="text/css" title="light">
<script src="assets/js/mustache.min.js"></script>
<script src="assets/js/jquery.js"></script>
<script src="assets/js/bootstrap.js"></script>
<script src="assets/js/scrollspy.js"></script>
<script src="assets/js/typeahead.jquery.min.js"></script>
<script src="assets/js/search.js"></script>
<script src="assets/js/compare-versions.js"></script>
<script src="assets/js/jquery.mCustomScrollbar.concat.min.js"></script>
<script src="assets/js/bootstrap-toc.min.js"></script>
<script src="assets/js/jquery.touchSwipe.min.js"></script>
<script src="assets/js/anchor.min.js"></script>
<script src="assets/js/tag_filtering.js"></script>
<script src="assets/js/language_switching.js"></script>
<script src="assets/js/styleswitcher.js"></script>
<script src="assets/js/lines_around_headings.js"></script>
<script src="assets/js/prism-core.js"></script>
<script src="assets/js/prism-autoloader.js"></script>
<script src="assets/js/prism_autoloader_path_override.js"></script>
<script src="assets/js/prism-keep-markup.js"></script>
<script src="assets/js/trie.js"></script>
<link rel="icon" type="image/png" href="assets/images/favicon.png">
<link rel="shortcut icon" href="assets/images/favicon.png">
</head>
<body class="no-script
">
<script>
$('body').removeClass('no-script');
</script>
<nav class="navbar navbar-fixed-top navbar-default" id="topnav">
<div class="container-fluid">
<div class="navbar-right">
<a id="toc-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-wrapper" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span title="light mode switch" class="glyphicon glyphicon-sunglasses pull-right" id="lightmode-icon"></span>
<form class="navbar-form pull-right" id="navbar-search-form">
<div class="form-group has-feedback">
<input type="text" class="form-control input-sm" name="search" id="sidenav-lookup-field" placeholder="search" disabled>
<span class="glyphicon glyphicon-search form-control-feedback" id="search-mgn-glass"></span>
</div>
</form>
</div>
<div class="navbar-header">
<a id="sidenav-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<a id="home-link" href="index.html" class="hotdoc-navbar-brand">
<img src="assets/images/meson_logo.png" alt="Home">
</a>
</div>
<div class="navbar-collapse collapse" id="navbar-wrapper">
<ul class="nav navbar-nav" id="menu">
<li class="dropdown">
<a class="dropdown-toggle" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Modules <span class="caret"></span>
</a>
<ul class="dropdown-menu" id="modules-menu">
<li>
<a href="CMake-module.html">CMake</a>
</li>
<li>
<a href="Cuda-module.html">CUDA</a>
</li>
<li>
<a href="Dlang-module.html">Dlang</a>
</li>
<li>
<a href="External-Project-module.html">External Project</a>
</li>
<li>
<a href="Fs-module.html">Filesystem</a>
</li>
<li>
<a href="Gnome-module.html">GNOME</a>
</li>
<li>
<a href="Hotdoc-module.html">Hotdoc</a>
</li>
<li>
<a href="i18n-module.html">i18n</a>
</li>
<li>
<a href="Icestorm-module.html">Icestorm</a>
</li>
<li>
<a href="Java-module.html">Java</a>
</li>
<li>
<a href="Keyval-module.html">Keyval</a>
</li>
<li>
<a href="Pkgconfig-module.html">Pkgconfig</a>
</li>
<li>
<a href="Python-3-module.html">Python 3</a>
</li>
<li>
<a href="Python-module.html">Python</a>
</li>
<li>
<a href="Qt4-module.html">Qt4</a>
</li>
<li>
<a href="Qt5-module.html">Qt5</a>
</li>
<li>
<a href="Qt6-module.html">Qt6</a>
</li>
<li>
<a href="Rust-module.html">Rust</a>
</li>
<li>
<a href="Simd-module.html">Simd</a>
</li>
<li>
<a href="SourceSet-module.html">SourceSet</a>
</li>
<li>
<a href="Wayland-module.html">Wayland</a>
</li>
<li>
<a href="Windows-module.html">Windows</a>
</li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Quick References <span class="caret"></span>
</a>
<ul class="dropdown-menu" id="quick-refs-menu">
<li>
<a href="Reference-manual.html">Functions</a>
</li>
<li>
<a href="Build-options.html">Options</a>
</li>
<li>
<a href="Configuration.html">Configuration</a>
</li>
<li>
<a href="Dependencies.html">Dependencies</a>
</li>
<li>
<a href="Unit-tests.html">Tests</a>
</li>
<li>
<a href="Syntax.html">Syntax</a>
</li>
</ul>
</li>
</ul>
<div class="hidden-xs hidden-sm navbar-text navbar-center">
<p><b>The Meson Build System</b></p>
</div>
</div>
</div>
</nav>
<main>
<div data-extension="core" data-hotdoc-in-toplevel="True" data-hotdoc-project="Meson-documentation" data-hotdoc-ref="Qt5-module.html" class="page_container" id="page-wrapper">
<script src="assets/js/utils.js"></script>
<div class="panel panel-collapse oc-collapsed" id="sidenav" data-hotdoc-role="navigation">
<script src="assets/js/full-width.js"></script>
<div id="sitenav-wrapper">
<iframe src="hotdoc-sitemap.html" id="sitenav-frame"></iframe>
</div>
</div>
<div id="body">
<div id="main">
<div id="page-description" data-hotdoc-role="main">
<h1 id="qt5-module">Qt5 module</h1>
<p>The Qt5 module provides tools to automatically deal with the various
tools and steps required for Qt.</p>
<h2 id="compile_resources">compile_resources</h2>
<p><em>New in 0.59.0</em></p>
<p>Compiles Qt's resources collection files (.qrc) into c++ files for compilation.</p>
<p>It takes no positional arguments, and the following keyword arguments:</p>
<ul>
<li>
<code>name</code> (string | empty): if provided a single .cpp file will be generated,
and the output of all qrc files will be combined in this file, otherwise
each qrc file be written to its own cpp file.</li>
<li>
<code>sources</code> (File | string | custom_target | custom_target index | generator_output)[]:
A list of sources to be transpiled. Required, must have at least one source
<em>New in 0.60.0</em>: support for custom_target, custom_target_index, and generator_output.</li>
<li>
<code>extra_args</code> string[]: Extra arguments to pass directly to <code>qt-rcc</code>
</li>
<li>
<code>method</code> string: The method to use to detect Qt, see <code>dependency()</code> for more
information.</li>
</ul>
<h2 id="compile_ui">compile_ui</h2>
<p><em>New in 0.59.0</em></p>
<p>Compiles Qt's ui files (.ui) into header files.</p>
<p>It takes no positional arguments, and the following keyword arguments:</p>
<ul>
<li>
<code>sources</code> (File | string | custom_target | custom_target index | generator_output)[]:
A list of sources to be transpiled. Required, must have at least one source
<em>New in 0.60.0</em>: support for custom_target, custom_target_index, and generator_output.</li>
<li>
<code>extra_args</code> string[]: Extra arguments to pass directly to <code>qt-uic</code>
</li>
<li>
<code>method</code> string: The method to use to detect Qt, see <code>dependency()</code> for more
information.</li>
<li>
<code>preserve_paths</code> bool: <em>Since 1.4.0</em>. If <code>true</code>, specifies that the output
files need to maintain their directory structure inside the target temporary
directory. For instance, when a file called <code>subdir/one.input</code> is processed
it generates a file <code>{target private directory}/subdir/one.out</code> when <code>true</code>,
and <code>{target private directory}/one.out</code> when <code>false</code> (default).</li>
</ul>
<h2 id="compile_moc">compile_moc</h2>
<p><em>New in 0.59.0</em></p>
<p>Compiles Qt's moc files (.moc) into header and/or source files. At least one of
the keyword arguments <code>headers</code> and <code>sources</code> must be provided.</p>
<p>It takes no positional arguments, and the following keyword arguments:</p>
<ul>
<li>
<code>sources</code> (File | string | custom_target | custom_target index | generator_output)[]:
A list of sources to be transpiled into .moc files for manual inclusion.
<em>New in 0.60.0</em>: support for custom_target, custom_target_index, and generator_output.</li>
<li>
<code>headers</code> (File | string | custom_target | custom_target index | generator_output)[]:
A list of headers to be transpiled into .cpp files
<em>New in 0.60.0</em>: support for custom_target, custom_target_index, and generator_output.</li>
<li>
<code>extra_args</code> string[]: Extra arguments to pass directly to <code>qt-moc</code>
</li>
<li>
<code>method</code> string: The method to use to detect Qt, see <code>dependency()</code> for more
information.</li>
<li>
<code>dependencies</code>: dependency objects whose include directories are used by moc.</li>
<li>
<code>include_directories</code> (string | IncludeDirectory)[]: A list of <code>include_directory()</code>
objects used when transpiling the .moc files</li>
<li>
<code>preserve_paths</code> bool: <em>New in 1.4.0</em>. If <code>true</code>, specifies that the output
files need to maintain their directory structure inside the target temporary
directory. For instance, when a file called <code>subdir/one.input</code> is processed
it generates a file <code>{target private directory}/subdir/one.out</code> when <code>true</code>,
and <code>{target private directory}/one.out</code> when <code>false</code> (default).</li>
</ul>
<h2 id="preprocess">preprocess</h2>
<p>Consider using <code>compile_resources</code>, <code>compile_ui</code>, and <code>compile_moc</code> instead.</p>
<p>Takes sources for moc, uic, and rcc, and converts them into c++ files for
compilation.</p>
<p>Has the following signature: <code>qt.preprocess(name: str | None, *sources: str)</code></p>
<p>If the <code>name</code> parameter is passed then all of the rcc files will be written to a single output file</p>
<p>The variadic <code>sources</code> arguments have been deprecated since Meson 0.59.0, as has the <code>sources</code> keyword argument. These passed files unmodified through the preprocessor, don't do this, just add the output of the generator to another sources list:</p>
<pre><code class="language-meson">sources = files('a.cpp', 'main.cpp', 'bar.c')
sources += qt.preprocess(qresources : ['resources'])
</code></pre>
<p>This method takes the following keyword arguments:</p>
<ul>
<li>
<code>qresources</code> (string | File)[]: Passed to the RCC compiler</li>
<li>
<code>ui_files</code>: (string | File | CustomTarget)[]: Passed the <code>uic</code> compiler</li>
<li>
<code>moc_sources</code>: (string | File | CustomTarget)[]: Passed the <code>moc</code> compiler. These are converted into .moc files meant to be <code>#include</code>ed</li>
<li>
<code>moc_headers</code>: (string | File | CustomTarget)[]: Passed the <code>moc</code> compiler. These will be converted into .cpp files</li>
<li>
<code>include_directories</code> (IncludeDirectories | string)[], the directories to add to header search path for <code>moc</code>
</li>
<li>
<code>moc_extra_arguments</code> string[]: any additional arguments to <code>moc</code>. Since v0.44.0.</li>
<li>
<code>uic_extra_arguments</code> string[]: any additional arguments to <code>uic</code>. Since v0.49.0.</li>
<li>
<code>rcc_extra_arguments</code> string[]: any additional arguments to <code>rcc</code>. Since v0.49.0.</li>
<li>
<code>dependencies</code> Dependency[]: dependency objects needed by moc. Available since v0.48.0.</li>
<li>
<code>sources</code>: a list of extra sources, which are added to the output unchanged. Deprecated in 0.59.0.</li>
<li>
<code>preserve_paths</code> bool: <em>New in 1.4.0</em>. If <code>true</code>, specifies that the output
files need to maintain their directory structure inside the target temporary
directory. For instance, when a file called <code>subdir/one.input</code> is processed
it generates a file <code>{target private directory}/subdir/one.out</code> when <code>true</code>,
and <code>{target private directory}/one.out</code> when <code>false</code> (default).</li>
</ul>
<p>It returns an array of targets and sources to pass to a compilation target.</p>
<h2 id="compile_translations">compile_translations</h2>
<p><em>since 0.44.0</em></p>
<p>This method generates the necessary targets to build translation files with
lrelease, it takes no positional arguments, and the following keyword arguments:</p>
<ul>
<li>
<code>ts_files</code> (File | string | custom_target | custom_target index | generator_output)[]:
the list of input translation files produced by Qt's lupdate tool.
<em>New in 0.60.0</em>: support for custom_target, custom_target_index, and generator_output.</li>
<li>
<code>install</code> bool: when true, this target is installed during the install step (optional).</li>
<li>
<code>install_dir</code> string: directory to install to (optional).</li>
<li>
<code>build_by_default</code> bool: when set to true, to have this target be built by
default, that is, when invoking <code>meson compile</code>; the default value is false
(optional).</li>
<li>
<code>qresource</code> string: rcc source file to extract ts_files from; cannot be used
with ts_files kwarg. Available since v0.56.0.</li>
<li>
<code>rcc_extra_arguments</code> string[]: any additional arguments to <code>rcc</code> (optional),
when used with `qresource. Available since v0.56.0.</li>
</ul>
<p>Returns either: a list of custom targets for the compiled
translations, or, if using a <code>qresource</code> file, a single custom target
containing the processed source file, which should be passed to a main
build target.</p>
<h2 id="has_tools">has_tools</h2>
<p><em>since 0.54.0</em></p>
<p>This method returns <code>true</code> if all tools used by this module are found,
<code>false</code> otherwise.</p>
<p>It should be used to compile optional Qt code:</p>
<pre><code class="language-meson">qt5 = import('qt5')
if qt5.has_tools(required: get_option('qt_feature'))
moc_files = qt5.preprocess(...)
...
endif
</code></pre>
<p>This method takes the following keyword arguments:</p>
<ul>
<li>
<code>required</code> bool | FeatureOption: by default, <code>required</code> is set to <code>false</code>. If <code>required</code> is set to
<code>true</code> or an enabled <a href="Build-options.html#features"><code>feature</code></a> and some tools are
missing Meson will abort.</li>
<li>
<code>method</code> string: method used to find the Qt dependency (<code>auto</code> by default).</li>
</ul>
<h2 id="dependencies">Dependencies</h2>
<p>See <a href="Dependencies.html#qt">Qt dependencies</a></p>
<p>The 'modules' argument is used to include Qt modules in the project.
See the Qt documentation for the <a href="http://doc.qt.io/qt-5/qtmodules.html">list of
modules</a>.</p>
<p>The 'private_headers' argument allows usage of Qt's modules private
headers. (since v0.47.0)</p>
<h2 id="example">Example</h2>
<p>A simple example would look like this:</p>
<pre><code class="language-meson">qt5 = import('qt5')
qt5_dep = dependency('qt5', modules: ['Core', 'Gui'])
inc = include_directories('includes')
moc_files = qt5.compile_moc(headers : 'myclass.h',
extra_args: ['-DMAKES_MY_MOC_HEADER_COMPILE'],
include_directories: inc,
dependencies: qt5_dep)
translations = qt5.compile_translations(ts_files : 'myTranslation_fr.ts', build_by_default : true)
executable('myprog', 'main.cpp', 'myclass.cpp', moc_files,
include_directories: inc,
dependencies : qt5_dep)
</code></pre>
<p>Sometimes, translations are embedded inside the binary using qresource
files. In this case the ts files do not need to be explicitly listed,
but will be inferred from the built qm files listed in the qresource
file. For example:</p>
<pre><code class="language-meson">qt5 = import('qt5')
qt5_dep = dependency('qt5', modules: ['Core', 'Gui'])
lang_cpp = qt5.compile_translations(qresource: 'lang.qrc')
executable('myprog', 'main.cpp', lang_cpp,
dependencies: qt5_dep)
</code></pre>
</div>
</div>
<div id="search_results">
<p>The results of the search are</p>
</div>
<div id="footer">
<hr>
<div class="license-description">
Website licensing information are available on the <a href="legal.html">Legal</a> page.
</div>
</div>
</div>
<div id="toc-column">
<div class="edit-button">
<a href="https://github.com/mesonbuild/meson/edit/master/docs/markdown/Qt5-module.md" data-hotdoc-role="edit-button">Edit on GitHub</a>
</div>
<div id="toc-wrapper">
<nav id="toc"></nav>
</div>
</div>
</div>
</main>
<script src="assets/js/navbar_offset_scroller.js"></script>
</body>
</html>