QtQml: Implement QmlElement

Equivalent to QML_ELEMENT in C++, this enables users to register classes
for use in QML by using the QmlElement decorator.

Change-Id: I697e486ef58b18cce4c310e4b556e28735a16d45
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>

1 files changed, 28 insertions, 0 deletions

diff --git a/sources/pyside2/doc/extras/QtQml.QmlElement.rst b/sources/pyside2/doc/extras/QtQml.QmlElement.rst
new file mode 100644
index 000000000..90a5134c1
--- /dev/null
+++ b/sources/pyside2/doc/extras/QtQml.QmlElement.rst
@@ -0,0 +1,28 @@
+.. currentmodule:: PySide2.QtQml
+.. _QmlElement:
+
+QmlElement
+**********
+
+.. 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.
+
+   ::
+      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:
+
+   ::
+      import com.library.name 1.0
+
+      ClassForQml {
+         // ...
+      }