6 files changed, 221 insertions, 0 deletions
diff --git a/examples/qml/referenceexamples/properties/birthdayparty.py b/examples/qml/referenceexamples/properties/birthdayparty.py
new file mode 100644
index 000000000..1a115101b
--- /dev/null
+++ b/examples/qml/referenceexamples/properties/birthdayparty.py
@@ -0,0 +1,41 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+from PySide6.QtCore import QObject, Property
+from PySide6.QtQml import QmlElement, ListProperty
+
+from person import Person
+
+
+# To be used on the @QmlElement decorator
+# (QML_IMPORT_MINOR_VERSION is optional)
+QML_IMPORT_NAME = "examples.properties.people"
+QML_IMPORT_MAJOR_VERSION = 1
+
+
+@QmlElement
+class BirthdayParty(QObject):
+
+    def __init__(self, parent=None):
+        super().__init__(parent)
+        self._host = None
+        self._guests = []
+
+    @Property(Person)
+    def host(self):
+        return self._host
+
+    @host.setter
+    def host(self, h):
+        self._host = h
+
+    def guest(self, n):
+        return self._guests[n]
+
+    def guestCount(self):
+        return len(self._guests)
+
+    def appendGuest(self, guest):
+        self._guests.append(guest)
+
+    guests = ListProperty(Person, appendGuest)
diff --git a/examples/qml/referenceexamples/properties/doc/properties.rst b/examples/qml/referenceexamples/properties/doc/properties.rst
new file mode 100644
index 000000000..909434c3c
--- /dev/null
+++ b/examples/qml/referenceexamples/properties/doc/properties.rst
@@ -0,0 +1,89 @@
+.. _qml-object-and-list-property-types-example:
+
+Extending QML - Object and List Property Types Example
+======================================================
+
+Exporting C++ Properties.
+
+This example builds on :ref:`qml-adding-types-example`.
+
+The Object and List Property Types example shows how to add object and list
+properties in QML. This example adds a BirthdayParty type that specifies a
+birthday party, consisting of a celebrant and a list of guests. People are
+specified using the People QML type built in the previous example.
+
+import examples.properties.people
+
+.. code-block:: javascript
+
+    BirthdayParty {
+        host: Person {
+            name: "Bob Jones"
+            shoe_size: 12
+        }
+        guests: [
+            Person { name: "Leo Hodges" },
+            Person { name: "Jack Smith" },
+            Person { name: "Anne Brown" }
+        ]
+    }
+
+Declare the BirthdayParty
+-------------------------
+
+The BirthdayParty class is declared like this:
+
+.. code-block:: python
+
+    from person import Person
+
+
+    # To be used on the @QmlElement decorator
+    # (QML_IMPORT_MINOR_VERSION is optional)
+    QML_IMPORT_NAME = "examples.properties.people"
+    QML_IMPORT_MAJOR_VERSION = 1
+
+
+    @QmlElement
+    class BirthdayParty(QObject):
+
+        def __init__(self, parent=None):
+            super().__init__(parent)
+            self._host = None
+            self._guests = []
+
+        @Property(Person)
+        def host(self):
+            return self._host
+
+        @host.setter
+        def host(self, h):
+            self._host = h
+
+        def guest(self, n):
+            return self._guests[n]
+
+        def guestCount(self):
+            return len(self._guests)
+
+        def appendGuest(self, guest):
+            self._guests.append(guest)
+
+        guests = ListProperty(Person, appendGuest)
+
+The class contains a member to store the celebrant object, and also a
+list member storing the Person instances.
+
+In QML, the type of a list properties - and the guests property is a list of
+people - are all of type ListProperty.  ListProperty is simple value
+type that contains a set of functions.  QML calls these functions
+whenever it needs to read from, write to or otherwise interact with
+the list.  In addition to concrete lists like the people list used in this
+example, the use of QQmlListProperty allows for "virtual lists" and other advanced
+scenarios.
+
+Running the Example
+-------------------
+
+The main.py file in the example includes a simple shell application that
+loads and runs the QML snippet shown at the beginning of this page.
diff --git a/examples/qml/referenceexamples/properties/example.qml b/examples/qml/referenceexamples/properties/example.qml
new file mode 100644
index 000000000..1486a0f92
--- /dev/null
+++ b/examples/qml/referenceexamples/properties/example.qml
@@ -0,0 +1,16 @@
+// Copyright (C) 2021 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+import examples.properties.people
+
+BirthdayParty {
+    host: Person {
+        name: "Bob Jones"
+        shoe_size: 12
+    }
+    guests: [
+        Person { name: "Leo Hodges" },
+        Person { name: "Jack Smith" },
+        Person { name: "Anne Brown" }
+    ]
+}
diff --git a/examples/qml/referenceexamples/properties/main.py b/examples/qml/referenceexamples/properties/main.py
new file mode 100644
index 000000000..a980b25aa
--- /dev/null
+++ b/examples/qml/referenceexamples/properties/main.py
@@ -0,0 +1,34 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+"""PySide6 port of the qml/examples/qml/referenceexamples/properties example from Qt v6.x"""
+
+from pathlib import Path
+import sys
+
+from PySide6.QtCore import QCoreApplication, QUrl
+from PySide6.QtQml import QQmlComponent, QQmlEngine
+
+from person import Person
+from birthdayparty import BirthdayParty
+
+
+if __name__ == '__main__':
+    app = QCoreApplication(sys.argv)
+
+    qml_file = Path(__file__).parent / "example.qml"
+    url = QUrl.fromLocalFile(qml_file)
+    engine = QQmlEngine()
+    component = QQmlComponent(engine, url)
+
+    party = component.create()
+    if party:
+        print(f"{party.host} is having a birthday!\nThey are inviting:")
+        for g in range(party.guestCount()):
+            name = party.guest(g).name
+            print(f"    {name}")
+    else:
+        print(component.errors())
+
+    del engine
+    sys.exit(0)
diff --git a/examples/qml/referenceexamples/properties/person.py b/examples/qml/referenceexamples/properties/person.py
new file mode 100644
index 000000000..4cc54260a
--- /dev/null
+++ b/examples/qml/referenceexamples/properties/person.py
@@ -0,0 +1,35 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+from PySide6.QtCore import QObject, Property
+from PySide6.QtQml import QmlElement
+
+# To be used on the @QmlElement decorator
+# (QML_IMPORT_MINOR_VERSION is optional)
+QML_IMPORT_NAME = "examples.properties.people"
+QML_IMPORT_MAJOR_VERSION = 1
+
+
+@QmlElement
+class Person(QObject):
+    def __init__(self, parent=None):
+        super().__init__(parent)
+        self._name = ''
+        self._shoe_size = 0
+
+    @Property(str)
+    def name(self):
+        return self._name
+
+    @name.setter
+    def name(self, n):
+        self._name = n
+
+    @Property(int)
+    def shoe_size(self):
+        return self._shoe_size
+
+    @shoe_size.setter
+    def shoe_size(self, s):
+        self._shoe_size = s
+
diff --git a/examples/qml/referenceexamples/properties/properties.pyproject b/examples/qml/referenceexamples/properties/properties.pyproject
new file mode 100644
index 000000000..0f5958fc3
--- /dev/null
+++ b/examples/qml/referenceexamples/properties/properties.pyproject
@@ -0,0 +1,6 @@
+{
+    "files": ["example.qml",
+              "main.py",
+              "person.py",
+              "birthdayparty.py"]
+}