aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/extras/QtQml.QmlForeign.rst
diff options
context:
space:
mode:
Diffstat (limited to 'sources/pyside6/doc/extras/QtQml.QmlForeign.rst')
-rw-r--r--sources/pyside6/doc/extras/QtQml.QmlForeign.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/sources/pyside6/doc/extras/QtQml.QmlForeign.rst b/sources/pyside6/doc/extras/QtQml.QmlForeign.rst
new file mode 100644
index 000000000..90b821e9b
--- /dev/null
+++ b/sources/pyside6/doc/extras/QtQml.QmlForeign.rst
@@ -0,0 +1,28 @@
+.. currentmodule:: PySide6.QtQml
+.. py:decorator:: QmlForeign
+
+This decorator can be used to change the type that is created by QML.
+
+This is useful for registering types that cannot be amended by adding the
+QmlElement decorator, for example because they belong to 3rdparty libraries.
+
+.. code-block:: python
+
+ QML_IMPORT_NAME = "com.library.name"
+ QML_IMPORT_MAJOR_VERSION = 1
+ QML_IMPORT_MINOR_VERSION = 0 # Optional
+
+ @QmlNamedElement("QWidget")
+ @QmlForeign(QWidget)
+ class ForeignWidgetHelperClass(QObject):
+ ...
+
+Afterwards the class may be used in QML:
+
+.. code-block:: javascript
+
+ import com.library.name 1.0
+
+ QWidget {
+ // ...
+ }