From 9b8864f67412ecfad745111934f403318e6aab99 Mon Sep 17 00:00:00 2001 From: Adrian Herrmann Date: Fri, 29 Jul 2022 16:59:50 +0200 Subject: Add QML window example + shared QML module Port the Qt Quick example "Window and Screen" to PySide. This includes a "shared" QML module located in a sibling directory of the example. Task-number: PYSIDE-841 Change-Id: I7c8376701390b10d8b28bbf0ad04dce7a3089b20 Reviewed-by: Friedemann Kleint Reviewed-by: Cristian Maureira-Fredes (cherry picked from commit ef8d3daa8f4d19c48e44874dd6e38a3ed4d02425) Reviewed-by: Adrian Herrmann --- examples/declarative/window/doc/window.rst | 35 ++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 examples/declarative/window/doc/window.rst (limited to 'examples/declarative/window/doc/window.rst') diff --git a/examples/declarative/window/doc/window.rst b/examples/declarative/window/doc/window.rst new file mode 100644 index 000000000..8736bb629 --- /dev/null +++ b/examples/declarative/window/doc/window.rst @@ -0,0 +1,35 @@ +Qt Quick Examples - Window and Screen +===================================== + +This example demonstrates the Window and Screen types in QML. + +.. image:: window.png + :width: 392 + :alt: Window and Screen screenshot + +In addition, this example demonstrates the usage of the Qt Resource System in +Qt for Python for more advanced scenarios. There are several QML files, one of +which imports a module from this sibling directory. Both this "shared" module +and the QML files of the example need to be compiled into Python modules with +the resource compiler rcc. + +For the "shared" module approach to work with QML and rcc, you need: + +* A module definition *qmldir* file +* A Qt Resource Collection file (.qrc) specifying all the QML files and other +resources, plus the *qmldir* file + +The .qrc file is the input to rcc. This will generate a Python module (called +*shared_rc* here) that can then be imported from the Python code. At runtime, +only this Python module is needed, not the .qrc file or any of the .qml files +or even the image resources, as they have all been compiled into the Python +module. + +For the example, rcc needs: + +* A Qt Resource Collection file (.qrc) specifying all the QML files and other +resources. There is no qmldir file here because this is not a module. + +This will generate a Python module (called *window_rc* here) that can then be +imported from the Python code. Again, only the Python module is needed at +runtime. -- cgit v1.2.3