aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/extras/QtQml.QmlNamedElement.rst
diff options
context:
space:
mode:
Diffstat (limited to 'sources/pyside6/doc/extras/QtQml.QmlNamedElement.rst')
-rw-r--r--sources/pyside6/doc/extras/QtQml.QmlNamedElement.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/sources/pyside6/doc/extras/QtQml.QmlNamedElement.rst b/sources/pyside6/doc/extras/QtQml.QmlNamedElement.rst
new file mode 100644
index 000000000..79eb9d7ad
--- /dev/null
+++ b/sources/pyside6/doc/extras/QtQml.QmlNamedElement.rst
@@ -0,0 +1,26 @@
+.. currentmodule:: PySide6.QtQml
+.. py:decorator:: QmlNamedElement
+
+This decorator registers a class it is attached to for use in QML under
+a name different from the class name, 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
+
+ @QmlNamedElement("ClassForQml")
+ class ClassWithSomeName(QObject):
+ ...
+
+Afterwards the class may be used in QML:
+
+.. code-block:: javascript
+
+ import com.library.name 1.0
+
+ ClassForQml {
+ // ...
+ }