aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/Qt5-module.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/markdown/Qt5-module.md')
-rw-r--r--docs/markdown/Qt5-module.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/markdown/Qt5-module.md b/docs/markdown/Qt5-module.md
new file mode 100644
index 0000000..2b733bb
--- /dev/null
+++ b/docs/markdown/Qt5-module.md
@@ -0,0 +1,15 @@
+# Qt5 module
+
+The Qt5 module provides tools to automatically deal with the various tools and steps required for Qt. The module has one method.
+
+## preprocess
+
+This method takes four keyword arguments, `moc_headers`, `moc_sources`, `ui_files` and `qresources` which define the files that require preprocessing with `moc`, `uic` and `rcc`. It returns an opaque object that should be passed to a main build target. A simple example would look like this:
+
+```meson
+qt5 = import('qt5')
+qt5_dep = dependency('qt5', ...)
+moc_files = qt5.preprocess(moc_headers : 'myclass.h')
+executable('myprog', 'main.cpp', 'myclass.cpp', moc_files,
+ dependencies : qt5_dep)
+```