From 7c448f5c27a51a60e27a54b79e298b53312ef2a8 Mon Sep 17 00:00:00 2001 From: Maximilian Goldstein Date: Thu, 27 Aug 2020 15:45:56 +0200 Subject: 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 --- sources/pyside2/doc/extras/QtQml.QmlElement.rst | 28 +++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 sources/pyside2/doc/extras/QtQml.QmlElement.rst (limited to 'sources/pyside2/doc') 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 { + // ... + } -- cgit v1.2.3