Fix the modelview programming tutorial

Add some documentation examples and snippets to fix most outstanding
C++ to Python conversion errors.

The rest looks roughly ok and could be improved by further fixing up
the snippet conversion.

Task-number: PYSIDE-1984
Change-Id: I8c1bdcbc4a07847b2731ef7e2b9ba666cc00ccd6
Reviewed-by: Christian Tismer <tismer@stackless.com>
(cherry picked from commit 2d7a4fc710e59d0e766ffa101dba383eff46bb50)

1 files changed, 161 insertions, 0 deletions

diff --git a/sources/pyside6/doc/tutorials/modelviewprogramming/stringlistmodel.py b/sources/pyside6/doc/tutorials/modelviewprogramming/stringlistmodel.py
new file mode 100644
index 000000000..9d3631f62
--- /dev/null
+++ b/sources/pyside6/doc/tutorials/modelviewprogramming/stringlistmodel.py
@@ -0,0 +1,161 @@
+#############################################################################
+##
+## 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$
+## 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 sys
+
+from PySide6.QtWidgets import (QApplication, QListView)
+from PySide6.QtCore import QAbstractListModel, QStringListModel, QModelIndex, Qt
+
+
+#! [0]
+class StringListModel(QAbstractListModel):
+    def __init__(self, strings, parent=None):
+        super().__init__(parent)
+        self._strings = strings
+
+#! [0]
+    def rowCount(self, parent=QModelIndex()):
+        """Returns the number of items in the string list as the number of rows
+           in the model."""
+        return len(self._strings)
+#! [0]
+
+#! [1]
+    def data(self, index, role):
+        """Returns an appropriate value for the requested data.
+           If the view requests an invalid index, an invalid variant is returned.
+           Any valid index that corresponds to a string in the list causes that
+          string to be returned."""
+        row = index.row()
+        if not index.isValid() or row >= len(self._strings):
+            return None
+        if role != Qt.DisplayRole and role != Qt.EditRole:
+            return None
+        return self._strings[row]
+#! [1]
+
+#! [2]
+    def headerData(self, section, orientation, role=Qt.DisplayRole):
+        """Returns the appropriate header string depending on the orientation of
+           the header and the section. If anything other than the display role is
+           requested, we return an invalid variant."""
+        if role != Qt.DisplayRole:
+            return None
+        if orientation == Qt.Horizontal:
+            return f"Column {section}"
+        return f"Row {section}"
+#! [2]
+
+#! [3]
+    def flags(self, index):
+        """Returns an appropriate value for the item's flags. Valid items are
+           enabled, selectable, and editable."""
+
+        if not index.isValid():
+            return Qt.ItemIsEnabled
+        return super().flags(index) | Qt.ItemIsEditable
+#! [3]
+
+    #! [4]
+    def setData(self, index, value, role=Qt.EditRole):
+        """Changes an item in the string list, but only if the following conditions
+           are met:
+
+           # The index supplied is valid.
+           # The index corresponds to an item to be shown in a view.
+           # The role associated with editing text is specified.
+
+           The dataChanged() signal is emitted if the item is changed."""
+
+        if index.isValid() and role == Qt.EditRole:
+            self._strings[index.row()] = value
+            self.dataChanged.emit(index, index, {role})
+            return True
+#! [4] #! [5]
+        return False
+#! [5]
+
+#! [6]
+    def insertRows(self, position, rows, parent):
+        """Inserts a number of rows into the model at the specified position."""
+        self.beginInsertRows(QModelIndex(), position, position + rows - 1)
+        for row in range(rows):
+            self._strings.insert(position, "")
+        self.endInsertRows()
+        return True
+#! [6] #! [7]
+#! [7]
+
+#! [8]
+    def removeRows(self, position, rows, parent):
+        """Removes a number of rows from the model at the specified position."""
+        self.beginRemoveRows(QModelIndex(), position, position + rows - 1)
+        for row in range(rows):
+            del self._strings[position]
+        self.endRemoveRows()
+        return True
+#! [8] #! [9]
+#! [9]
+
+
+#! [main0]
+if __name__ == '__main__':
+    app = QApplication(sys.argv)
+
+#! [main1]
+    numbers = ["One", "Two", "Three", "Four", "Five"]
+    model = StringListModel(numbers)
+#! [main0] #! [main1] #! [main2] #! [main3]
+    view = QListView()
+#! [main2]
+    view.setWindowTitle("View onto a string list model")
+#! [main4]
+    view.setModel(model)
+#! [main3] #! [main4]
+
+    model.insertRows(5, 7, QModelIndex())
+    for row in range(5, 12):
+        index = model.index(row, 0, QModelIndex())
+        model.setData(index, f"{row+1}")
+
+#! [main5]
+    view.show()
+    sys.exit(app.exec())
+#! [main5]