Add the 'grouped' example of the QML reference examples

Task-number: PYSIDE-841
Task-number: PYSIDE-1836
Change-Id: Iac93418494911a22c731cecd40464183ad092bb8
Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>

6 files changed, 381 insertions, 0 deletions

diff --git a/examples/declarative/referenceexamples/grouped/birthdayparty.py b/examples/declarative/referenceexamples/grouped/birthdayparty.py
new file mode 100644
index 000000000..2ae9fb12d
--- /dev/null
+++ b/examples/declarative/referenceexamples/grouped/birthdayparty.py
@@ -0,0 +1,79 @@
+#############################################################################
+##
+## Copyright (C) 2022 The Qt Company Ltd.
+## Contact: http://www.qt.io/licensing/
+##
+## This file is part of the Qt for Python examples of the Qt Toolkit.
+##
+## $QT_BEGIN_LICENSE:BSD$
+## You may use this file under the terms of the BSD license as follows:
+##
+## "Redistribution and use in source and binary forms, with or without
+## modification, are permitted provided that the following conditions are
+## met:
+##   * Redistributions of source code must retain the above copyright
+##     notice, this list of conditions and the following disclaimer.
+##   * Redistributions in binary form must reproduce the above copyright
+##     notice, this list of conditions and the following disclaimer in
+##     the documentation and/or other materials provided with the
+##     distribution.
+##   * Neither the name of The Qt Company Ltd nor the names of its
+##     contributors may be used to endorse or promote products derived
+##     from this software without specific prior written permission.
+##
+##
+## THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+## "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+## LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+## A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+## OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+## DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+## THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+## (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+## OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+##
+## $QT_END_LICENSE$
+##
+#############################################################################
+
+from PySide6.QtCore import QObject, ClassInfo, 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.grouped.people"
+QML_IMPORT_MAJOR_VERSION = 1
+
+
+@QmlElement
+@ClassInfo(DefaultProperty="guests")
+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/declarative/referenceexamples/grouped/doc/grouped.rst b/examples/declarative/referenceexamples/grouped/doc/grouped.rst
new file mode 100644
index 000000000..691c1d393
--- /dev/null
+++ b/examples/declarative/referenceexamples/grouped/doc/grouped.rst
@@ -0,0 +1,17 @@
+.. _qml-grouped-example:
+
+Extending QML - Grouped Properties Example
+==========================================
+
+Grouped Properties.
+
+This example builds on the the :ref:`qml-default-property-example`,
+the :ref:`qml-inheritance-and-coercion-example`
+the :ref:`qml-object-and-list-property-types-example`
+and the :ref:`qml-adding-types-example`.
+
+Running the Example
+-------------------
+
+The ``main.py`` file in the example includes a simple shell application that
+loads and runs the QML snippet shown below.
diff --git a/examples/declarative/referenceexamples/grouped/example.qml b/examples/declarative/referenceexamples/grouped/example.qml
new file mode 100644
index 000000000..95d2990bf
--- /dev/null
+++ b/examples/declarative/referenceexamples/grouped/example.qml
@@ -0,0 +1,80 @@
+/****************************************************************************
+**
+** Copyright (C) 2022 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt for Python examples of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** BSD License Usage
+** Alternatively, you may use this file under the terms of the BSD license
+** as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+**   * Redistributions of source code must retain the above copyright
+**     notice, this list of conditions and the following disclaimer.
+**   * Redistributions in binary form must reproduce the above copyright
+**     notice, this list of conditions and the following disclaimer in
+**     the documentation and/or other materials provided with the
+**     distribution.
+**   * Neither the name of The Qt Company Ltd nor the names of its
+**     contributors may be used to endorse or promote products derived
+**     from this software without specific prior written permission.
+**
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick
+
+import examples.grouped.people
+
+BirthdayParty {
+    host: Boy {
+        name: "Bob Jones"
+        shoe { size: 12; color: "white"; brand: "Bikey"; price: 90.0 }
+    }
+
+    Boy {
+        name: "Leo Hodges"
+        shoe { size: 10; color: "black"; brand: "Thebok"; price: 59.95 }
+    }
+    Boy { name: "Jack Smith"
+        shoe {
+            size: 8
+            color: "blue"
+            brand: "Luma"
+            price: 19.95
+        }
+    }
+    Girl {
+        name: "Anne Brown"
+        shoe.size: 7
+        shoe.color: "red"
+        shoe.brand: "Job Macobs"
+        shoe.price: 699.99
+    }
+}
diff --git a/examples/declarative/referenceexamples/grouped/grouped.pyproject b/examples/declarative/referenceexamples/grouped/grouped.pyproject
new file mode 100644
index 000000000..3c01c40c2
--- /dev/null
+++ b/examples/declarative/referenceexamples/grouped/grouped.pyproject
@@ -0,0 +1,3 @@
+{
+    "files": ["main.py", "birthdayparty.py", "person.py", "example.qml"]
+}
diff --git a/examples/declarative/referenceexamples/grouped/main.py b/examples/declarative/referenceexamples/grouped/main.py
new file mode 100644
index 000000000..9911ccc3a
--- /dev/null
+++ b/examples/declarative/referenceexamples/grouped/main.py
@@ -0,0 +1,80 @@
+#############################################################################
+##
+## Copyright (C) 2022 The Qt Company Ltd.
+## Contact: http://www.qt.io/licensing/
+##
+## This file is part of the Qt for Python examples of the Qt Toolkit.
+##
+## $QT_BEGIN_LICENSE:BSD$
+## You may use this file under the terms of the BSD license as follows:
+##
+## "Redistribution and use in source and binary forms, with or without
+## modification, are permitted provided that the following conditions are
+## met:
+##   * Redistributions of source code must retain the above copyright
+##     notice, this list of conditions and the following disclaimer.
+##   * Redistributions in binary form must reproduce the above copyright
+##     notice, this list of conditions and the following disclaimer in
+##     the documentation and/or other materials provided with the
+##     distribution.
+##   * Neither the name of The Qt Company Ltd nor the names of its
+##     contributors may be used to endorse or promote products derived
+##     from this software without specific prior written permission.
+##
+##
+## THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+## "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+## LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+## A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+## OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+## DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+## THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+## (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+## OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+##
+## $QT_END_LICENSE$
+##
+#############################################################################
+
+"""PySide6 port of the qml/examples/qml/referenceexamples/default 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 Boy, Girl
+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 not party:
+        print(component.errors())
+        del engine
+        sys.exit(-1)
+    host = party.host
+    print(f"{host.name} is having a birthday!")
+    if isinstance(host, Boy):
+        print("He is inviting:")
+    else:
+        print("She is inviting:")
+    best_shoe = None
+    for g in range(party.guestCount()):
+        guest = party.guest(g)
+        name = guest.name
+        print(f"    {name}")
+        if not best_shoe or best_shoe.shoe.price < guest.shoe.price:
+            best_shoe = guest;
+    if best_shoe:
+          print(f"{best_shoe.name} is wearing the best shoes!");
+    del engine
+    sys.exit(0)
diff --git a/examples/declarative/referenceexamples/grouped/person.py b/examples/declarative/referenceexamples/grouped/person.py
new file mode 100644
index 000000000..c05c76777
--- /dev/null
+++ b/examples/declarative/referenceexamples/grouped/person.py
@@ -0,0 +1,122 @@
+#############################################################################
+##
+## Copyright (C) 2022 The Qt Company Ltd.
+## Contact: http://www.qt.io/licensing/
+##
+## This file is part of the Qt for Python examples of the Qt Toolkit.
+##
+## $QT_BEGIN_LICENSE:BSD$
+## You may use this file under the terms of the BSD license as follows:
+##
+## "Redistribution and use in source and binary forms, with or without
+## modification, are permitted provided that the following conditions are
+## met:
+##   * Redistributions of source code must retain the above copyright
+##     notice, this list of conditions and the following disclaimer.
+##   * Redistributions in binary form must reproduce the above copyright
+##     notice, this list of conditions and the following disclaimer in
+##     the documentation and/or other materials provided with the
+##     distribution.
+##   * Neither the name of The Qt Company Ltd nor the names of its
+##     contributors may be used to endorse or promote products derived
+##     from this software without specific prior written permission.
+##
+##
+## THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+## "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+## LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+## A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+## OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+## DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+## THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+## (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+## OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+##
+## $QT_END_LICENSE$
+##
+#############################################################################
+
+from PySide6.QtCore import QObject, Property
+from PySide6.QtGui import QColor
+from PySide6.QtQml import QmlAnonymous, QmlElement
+
+# To be used on the @QmlElement decorator
+# (QML_IMPORT_MINOR_VERSION is optional)
+QML_IMPORT_NAME = "examples.grouped.people"
+QML_IMPORT_MAJOR_VERSION = 1
+
+
+@QmlAnonymous
+class ShoeDescription(QObject):
+    def __init__(self, parent=None):
+        super().__init__(parent)
+        self._brand = ''
+        self._size = 0
+        self._price = 0
+        self._color = QColor()
+
+    @Property(str)
+    def brand(self):
+        return self._brand
+
+    @brand.setter
+    def brand(self, b):
+        self._brand = b
+
+    @Property(int)
+    def size(self):
+        return self._size
+
+    @size.setter
+    def size(self, s):
+        self._size = s
+
+    @Property(float)
+    def price(self):
+        return self._price
+
+    @price.setter
+    def price(self, p):
+        self._price = p
+
+    @Property(QColor)
+    def color(self):
+        return self._color
+
+    @color.setter
+    def color(self, c):
+        self._color = c
+
+
+@QmlAnonymous
+class Person(QObject):
+    def __init__(self, parent=None):
+        super().__init__(parent)
+        self._name = ''
+        self._shoe = ShoeDescription()
+
+    @Property(str)
+    def name(self):
+        return self._name
+
+    @name.setter
+    def name(self, n):
+        self._name = n
+
+    @Property(ShoeDescription)
+    def shoe(self):
+        return self._shoe
+
+
+@QmlElement
+class Boy(Person):
+    def __init__(self, parent=None):
+        super().__init__(parent)
+
+
+@QmlElement
+class Girl(Person):
+    def __init__(self, parent=None):
+        super().__init__(parent)