diff options
author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2020-11-02 16:11:52 +0100 |
---|---|---|
committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2020-11-02 16:12:04 +0000 |
commit | 25180730194bec25f915f32ab846ea583fb1493f (patch) | |
tree | 9a73e0336ecf21e085d99d6a651c5547b9eb99f8 /sources/pyside6/doc/extras/QtQml.QmlElement.rst | |
parent | 6e3e7b9ca0548430aaa5e2555d6e02c64625fa3f (diff) |
Rename PySide2 to PySide6
Adapt CMake files, build scripts, tests and examples.
Task-number: PYSIDE-904
Change-Id: I845f7b006e9ad274fed5444ec4c1f9dbe176ff88
Reviewed-by: Christian Tismer <tismer@stackless.com>
Diffstat (limited to 'sources/pyside6/doc/extras/QtQml.QmlElement.rst')
-rw-r--r-- | sources/pyside6/doc/extras/QtQml.QmlElement.rst | 28 |
1 files changed, 28 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..b567bb3cc --- /dev/null +++ b/sources/pyside6/doc/extras/QtQml.QmlElement.rst @@ -0,0 +1,28 @@ +.. currentmodule:: PySide6.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 { + // ... + } |