aboutsummaryrefslogtreecommitdiffstats
path: root/examples/declarative/extending/chapter6-plugins/doc/chapter6-plugins.rst
diff options
context:
space:
mode:
authorShyamnath Premnadh <Shyamnath.Premnadh@qt.io>2022-04-10 16:13:58 +0200
committerShyamnath Premnadh <Shyamnath.Premnadh@qt.io>2022-07-07 16:01:22 +0200
commit5fbdfa3ec1df74368316ab0f3ab2ec03781e0df0 (patch)
tree9d4af4219ab21514072489f86833673c0b466c9d /examples/declarative/extending/chapter6-plugins/doc/chapter6-plugins.rst
parentdc058bddb1f1089c007721c9301e174f3f7a7887 (diff)
PySide6-examples: QML Plugins examples
- example that can be easily visualized using pyside6-qml tool Task-number: PYSIDE-1878 Change-Id: Ibf909bbd9efa586ed05318c6b6402ff00a33848e Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'examples/declarative/extending/chapter6-plugins/doc/chapter6-plugins.rst')
-rw-r--r--examples/declarative/extending/chapter6-plugins/doc/chapter6-plugins.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/examples/declarative/extending/chapter6-plugins/doc/chapter6-plugins.rst b/examples/declarative/extending/chapter6-plugins/doc/chapter6-plugins.rst
new file mode 100644
index 000000000..10aba1e8f
--- /dev/null
+++ b/examples/declarative/extending/chapter6-plugins/doc/chapter6-plugins.rst
@@ -0,0 +1,21 @@
+.. _qml-chapter6-plugins-example:
+
+Extending QML - Plugins Example
+===============================
+
+This example refers to the Python version of using a QML plugin in Python. The idea of plugins in
+Python is non-existent because Python modules are dynamically loaded anyway. We use this idea and
+our QML type registration decorators - QmlELement/QmlNamedElement - to register the QML modules as
+they are imported. The pyside6-qml tool does this for you by simply pointing to the .qml file.
+
+.. image:: plugins.png
+ :width: 400
+ :alt: Plugins Example
+
+
+Running the Example
+-------------------
+
+.. code-block:: shell
+
+ pyside6-pyqml examples/declarative/extending/chapter6-plugins/app.qml -I examples/declarative/extending/chapter6-plugins/Charts