Add TableModelColumn

This allows us to support simple object rows by default,
which we expect to be the most common use case for TableModel.

Complex rows are supported, but with a limited subset of functionality.

Things that could be improved:

- Would be nice if we could get arbitrary/dynamic properties
  like ListModel has, without the complex code that comes
  with it. That way we could get rid of all of the role properties
  and users could have their own custom roles. The limitation
  of only having built-in roles becomes too restrictive very
  quickly.

Change-Id: Icbdb6b39665851c55c69c0b79e0aa523c5d46dfe
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>

4 files changed, 196 insertions, 136 deletions

diff --git a/src/qml/doc/snippets/qml/tablemodel/fruit-example-complex.qml b/src/qml/doc/snippets/qml/tablemodel/fruit-example-complex.qml
new file mode 100644
index 0000000000..104a2209d7
--- /dev/null
+++ b/src/qml/doc/snippets/qml/tablemodel/fruit-example-complex.qml
@@ -0,0 +1,134 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation 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$
+**
+****************************************************************************/
+
+//![file]
+import QtQuick 2.12
+import QtQuick.Window 2.12
+import Qt.labs.qmlmodels 1.0
+
+Window {
+    width: 400
+    height: 400
+    visible: true
+
+    TableView {
+        anchors.fill: parent
+        columnSpacing: 1
+        rowSpacing: 1
+        boundsBehavior: Flickable.StopAtBounds
+
+        model: TableModel {
+            TableModelColumn {
+                display: function(modelIndex) { return rows[modelIndex.row][0].checked }
+                setDisplay: function(modelIndex, cellData) { rows[modelIndex.row][0].checked = cellData }
+            }
+            TableModelColumn {
+                display: function(modelIndex) { return rows[modelIndex.row][1].amount }
+                setDisplay: function(modelIndex, cellData) { rows[modelIndex.row][1].amount = cellData }
+            }
+            TableModelColumn {
+                display: function(modelIndex) { return rows[modelIndex.row][2].fruitType }
+                setDisplay: function(modelIndex, cellData) { rows[modelIndex.row][2].fruitType = cellData }
+            }
+            TableModelColumn {
+                display: function(modelIndex) { return rows[modelIndex.row][3].fruitName }
+                setDisplay: function(modelIndex, cellData) { rows[modelIndex.row][3].fruitName = cellData }
+            }
+            TableModelColumn {
+                display: function(modelIndex) { return rows[modelIndex.row][4].fruitPrice }
+                setDisplay: function(modelIndex, cellData) { rows[modelIndex.row][4].fruitPrice = cellData }
+            }
+
+            // Each row is one type of fruit that can be ordered
+//![rows]
+            rows: [
+                [
+                    // Each object (line) is one cell/column.
+                    { checked: false, checkable: true },
+                    { amount: 1 },
+                    { fruitType: "Apple" },
+                    { fruitName: "Granny Smith" },
+                    { fruitPrice: 1.50 }
+                ],
+                [
+                    { checked: true, checkable: true },
+                    { amount: 4 },
+                    { fruitType: "Orange" },
+                    { fruitName: "Navel" },
+                    { fruitPrice: 2.50 }
+                ],
+                [
+                    { checked: false, checkable: false },
+                    { amount: 1 },
+                    { fruitType: "Banana" },
+                    { fruitName: "Cavendish" },
+                    { fruitPrice: 3.50 }
+                ]
+            ]
+//![rows]
+        }
+//![delegate]
+        delegate:  TextInput {
+            text: model.display
+            padding: 12
+            selectByMouse: true
+
+            onAccepted: model.display = text
+
+            Rectangle {
+                anchors.fill: parent
+                color: "#efefef"
+                z: -1
+            }
+        }
+//![delegate]
+    }
+}
+//![file]
diff --git a/src/qml/doc/snippets/qml/tablemodel/fruit-example-delegatechooser.qml b/src/qml/doc/snippets/qml/tablemodel/fruit-example-delegatechooser.qml
index 3d44f61668..d3f6176c70 100644
--- a/src/qml/doc/snippets/qml/tablemodel/fruit-example-delegatechooser.qml
+++ b/src/qml/doc/snippets/qml/tablemodel/fruit-example-delegatechooser.qml
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2018 The Qt Company Ltd.
+** Copyright (C) 2019 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the documentation of the Qt Toolkit.
@@ -65,32 +65,37 @@ ApplicationWindow {
         boundsBehavior: Flickable.StopAtBounds
 
         model: TableModel {
+            TableModelColumn { display: "checked" }
+            TableModelColumn { display: "amount" }
+            TableModelColumn { display: "fruitType" }
+            TableModelColumn { display: "fruitName" }
+            TableModelColumn { display: "fruitPrice" }
+
             // Each row is one type of fruit that can be ordered
 //![rows]
             rows: [
-                [
-                    // Each object (line) is one cell/column,
-                    // and each property in that object is a role.
-                    { checked: false, checkable: true },
-                    { amount: 1 },
-                    { fruitType: "Apple" },
-                    { fruitName: "Granny Smith" },
-                    { fruitPrice: 1.50 }
-                ],
-                [
-                    { checked: true, checkable: true },
-                    { amount: 4 },
-                    { fruitType: "Orange" },
-                    { fruitName: "Navel" },
-                    { fruitPrice: 2.50 }
-                ],
-                [
-                    { checked: false, checkable: true },
-                    { amount: 1 },
-                    { fruitType: "Banana" },
-                    { fruitName: "Cavendish" },
-                    { fruitPrice: 3.50 }
-                ]
+                {
+                    // Each property is one cell/column.
+                    checked: false,
+                    amount: 1,
+                    fruitType: "Apple",
+                    fruitName: "Granny Smith",
+                    fruitPrice: 1.50
+                },
+                {
+                    checked: true,
+                    amount: 4,
+                    fruitType: "Orange",
+                    fruitName: "Navel",
+                    fruitPrice: 2.50
+                },
+                {
+                    checked: false,
+                    amount: 1,
+                    fruitType: "Banana",
+                    fruitName: "Cavendish",
+                    fruitPrice: 3.50
+                }
             ]
 //![rows]
         }
@@ -99,15 +104,15 @@ ApplicationWindow {
             DelegateChoice {
                 column: 0
                 delegate: CheckBox {
-                    checked: model.checked
-                    onToggled: model.checked = checked
+                    checked: model.display
+                    onToggled: model.display = checked
                 }
             }
             DelegateChoice {
                 column: 1
                 delegate: SpinBox {
-                    value: model.amount
-                    onValueModified: model.amount = value
+                    value: model.display
+                    onValueModified: model.display = value
                 }
             }
             DelegateChoice {
diff --git a/src/qml/doc/snippets/qml/tablemodel/fruit-example-simpledelegate.qml b/src/qml/doc/snippets/qml/tablemodel/fruit-example-simpledelegate.qml
index 5f00eb484b..f51c1818c3 100644
--- a/src/qml/doc/snippets/qml/tablemodel/fruit-example-simpledelegate.qml
+++ b/src/qml/doc/snippets/qml/tablemodel/fruit-example-simpledelegate.qml
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2018 The Qt Company Ltd.
+** Copyright (C) 2019 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the documentation of the Qt Toolkit.
@@ -65,32 +65,37 @@ Window {
         boundsBehavior: Flickable.StopAtBounds
 
         model: TableModel {
+            TableModelColumn { display: "checked" }
+            TableModelColumn { display: "amount" }
+            TableModelColumn { display: "fruitType" }
+            TableModelColumn { display: "fruitName" }
+            TableModelColumn { display: "fruitPrice" }
+
             // Each row is one type of fruit that can be ordered
 //![rows]
             rows: [
-                [
-                    // Each object (line) is one cell/column,
-                    // and each property in that object is a role.
-                    { checked: false, checkable: true },
-                    { amount: 1 },
-                    { fruitType: "Apple" },
-                    { fruitName: "Granny Smith" },
-                    { fruitPrice: 1.50 }
-                ],
-                [
-                    { checked: true, checkable: true },
-                    { amount: 4 },
-                    { fruitType: "Orange" },
-                    { fruitName: "Navel" },
-                    { fruitPrice: 2.50 }
-                ],
-                [
-                    { checked: false, checkable: true },
-                    { amount: 1 },
-                    { fruitType: "Banana" },
-                    { fruitName: "Cavendish" },
-                    { fruitPrice: 3.50 }
-                ]
+                {
+                    // Each property is one cell/column.
+                    checked: false,
+                    amount: 1,
+                    fruitType: "Apple",
+                    fruitName: "Granny Smith",
+                    fruitPrice: 1.50
+                },
+                {
+                    checked: true,
+                    amount: 4,
+                    fruitType: "Orange",
+                    fruitName: "Navel",
+                    fruitPrice: 2.50
+                },
+                {
+                    checked: false,
+                    amount: 1,
+                    fruitType: "Banana",
+                    fruitName: "Cavendish",
+                    fruitPrice: 3.50
+                }
             ]
 //![rows]
         }
@@ -100,7 +105,6 @@ Window {
             padding: 12
             selectByMouse: true
 
-            // TODO: the property used here is undefined
             onAccepted: model.display = text
 
             Rectangle {
diff --git a/src/qml/doc/snippets/qml/tablemodel/roleDataProvider.qml b/src/qml/doc/snippets/qml/tablemodel/roleDataProvider.qml
deleted file mode 100644
index 63978a370d..0000000000
--- a/src/qml/doc/snippets/qml/tablemodel/roleDataProvider.qml
+++ /dev/null
@@ -1,83 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2019 The Qt Company Ltd.
-** Contact: https://www.qt.io/licensing/
-**
-** This file is part of the documentation 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$
-**
-****************************************************************************/
-//![0]
-import QtQuick 2.12
-import Qt.labs.qmlmodels 1.0
-
-TableView {
-    columnSpacing: 1; rowSpacing: 1
-    model:  TableModel {
-        property real taxPercent: 10
-        rows: [
-            [{ fruitType: "Apple" }, { fruitPrice: 1.50 }],
-            [{ fruitType: "Orange" }, { fruitPrice: 2.50 }]
-        ]
-        roleDataProvider: function(index, role, cellData) {
-            if (role === "display") {
-                if (cellData.hasOwnProperty("fruitPrice")) {
-                    console.log("row", index.row, "taxing your fruit", JSON.stringify(cellData))
-                    return (cellData.fruitPrice * (1 + taxPercent / 100)).toFixed(2);
-                }
-                else if (cellData.hasOwnProperty("fruitType"))
-                    return cellData.fruitType;
-            }
-            return cellData;
-        }
-    }
-    delegate: Rectangle {
-        implicitWidth: 150; implicitHeight: 30
-        color: "lightsteelblue"
-        Text {
-            x: 6; anchors.verticalCenter: parent.verticalCenter
-            text: display
-        }
-    }
-}
-//![0]