aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/extras/QtQml.QmlElement.rst
diff options
context:
space:
mode:
Diffstat (limited to 'sources/pyside6/doc/extras/QtQml.QmlElement.rst')
-rw-r--r--sources/pyside6/doc/extras/QtQml.QmlElement.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/sources/pyside6/doc/extras/QtQml.QmlElement.rst b/sources/pyside6/doc/extras/QtQml.QmlElement.rst
new file mode 100644
index 000000000..66397b2d9
--- /dev/null
+++ b/sources/pyside6/doc/extras/QtQml.QmlElement.rst
@@ -0,0 +1,25 @@
+.. currentmodule:: PySide6.QtQml
+.. py:decorator:: QmlElement
+
+This decorator registers a class it is attached to for use in QML, using
+global variables to specify the import name and version.
+
+.. code-block:: python
+
+ QML_IMPORT_NAME = "com.library.name"
+ QML_IMPORT_MAJOR_VERSION = 1
+ QML_IMPORT_MINOR_VERSION = 0 # Optional
+
+ @QmlElement
+ class ClassForQml(QObject):
+ # ...
+
+Afterwards the class may be used in QML:
+
+.. code-block:: python
+
+ import com.library.name 1.0
+
+ ClassForQml {
+ // ...
+ }