Tumbler: add wrap property

[ChangeLog][Tumbler] Added wrap property to control whether or not
tumbler wraps when it reaches the top and bottom.

Change-Id: I27c543d98f7bc574bc5dc882a130abe0dcc13cea
Task-number: QTBUG-53587
Reviewed-by: J-P Nurmi <jpnurmi@qt.io>

11 files changed, 248 insertions, 48 deletions

diff --git a/src/imports/controls/Tumbler.qml b/src/imports/controls/Tumbler.qml
index 13bc0859..371c705f 100644
--- a/src/imports/controls/Tumbler.qml
+++ b/src/imports/controls/Tumbler.qml
@@ -35,15 +35,15 @@
 ****************************************************************************/
 
 import QtQuick 2.6
-import QtQuick.Controls 2.0
-import QtQuick.Templates 2.0 as T
+import QtQuick.Controls 2.1
+import QtQuick.Controls.impl 2.1
+import QtQuick.Templates 2.1 as T
 
 T.Tumbler {
     id: control
     implicitWidth: 60
     implicitHeight: 200
 
-    //! [delegate]
     delegate: Text {
         id: label
         text: modelData
@@ -53,29 +53,20 @@ T.Tumbler {
         horizontalAlignment: Text.AlignHCenter
         verticalAlignment: Text.AlignVCenter
     }
-    //! [delegate]
 
-    //! [contentItem]
-    contentItem: PathView {
-        id: pathView
+    contentItem: TumblerView {
+        id: tumblerView
         model: control.model
         delegate: control.delegate
-        clip: true
-        pathItemCount: control.visibleItemCount + 1
-        preferredHighlightBegin: 0.5
-        preferredHighlightEnd: 0.5
-        dragMargin: width / 2
-
         path: Path {
-            startX: pathView.width / 2
-            startY: -pathView.delegateHeight / 2
+            startX: tumblerView.width / 2
+            startY: -tumblerView.delegateHeight / 2
             PathLine {
-                x: pathView.width / 2
-                y: pathView.pathItemCount * pathView.delegateHeight - pathView.delegateHeight / 2
+                x: tumblerView.width / 2
+                y: (control.visibleItemCount + 1) * tumblerView.delegateHeight - tumblerView.delegateHeight / 2
             }
         }
 
         property real delegateHeight: control.availableHeight / control.visibleItemCount
     }
-    //! [contentItem]
 }
diff --git a/src/imports/controls/doc/qtquickcontrols2.qdocconf b/src/imports/controls/doc/qtquickcontrols2.qdocconf
index 95c438a6..73f9bdfc 100644
--- a/src/imports/controls/doc/qtquickcontrols2.qdocconf
+++ b/src/imports/controls/doc/qtquickcontrols2.qdocconf
@@ -38,7 +38,6 @@ exampledirs += ../../../../examples/quickcontrols2 \
                ../ \
                ../../../quicktemplates2 \
                ../../calendar \
-               ../../../../tests/auto/controls/data \
                snippets
 
 examplesinstallpath = quickcontrols2
diff --git a/src/imports/controls/doc/snippets/qtquickcontrols2-tumbler-listView.qml b/src/imports/controls/doc/snippets/qtquickcontrols2-tumbler-listView.qml
new file mode 100644
index 00000000..ff3ecd81
--- /dev/null
+++ b/src/imports/controls/doc/snippets/qtquickcontrols2-tumbler-listView.qml
@@ -0,0 +1,46 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick 2.8
+import QtQuick.Controls 2.1
+
+//! [contentItem]
+Tumbler {
+    id: tumbler
+
+    contentItem: ListView {
+        model: tumbler.model
+        delegate: tumbler.delegate
+
+        snapMode: ListView.SnapToItem
+        highlightRangeMode: ListView.StrictlyEnforceRange
+        preferredHighlightBegin: height / 2 - (height / tumbler.visibleItemCount / 2)
+        preferredHighlightEnd: height / 2  + (height / tumbler.visibleItemCount / 2)
+        clip: true
+    }
+}
+//! [contentItem]
diff --git a/src/imports/controls/doc/snippets/qtquickcontrols2-tumbler-pathView.qml b/src/imports/controls/doc/snippets/qtquickcontrols2-tumbler-pathView.qml
new file mode 100644
index 00000000..957112e0
--- /dev/null
+++ b/src/imports/controls/doc/snippets/qtquickcontrols2-tumbler-pathView.qml
@@ -0,0 +1,57 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick 2.8
+import QtQuick.Controls 2.1
+
+//! [contentItem]
+Tumbler {
+    id: tumbler
+
+    contentItem: PathView {
+        id: pathView
+        model: tumbler.model
+        delegate: tumbler.delegate
+        clip: true
+        pathItemCount: tumbler.visibleItemCount + 1
+        preferredHighlightBegin: 0.5
+        preferredHighlightEnd: 0.5
+        dragMargin: width / 2
+
+        path: Path {
+            startX: pathView.width / 2
+            startY: -pathView.delegateHeight / 2
+            PathLine {
+                x: pathView.width / 2
+                y: pathView.pathItemCount * pathView.delegateHeight - pathView.delegateHeight / 2
+            }
+        }
+
+        property real delegateHeight: tumbler.availableHeight / tumbler.visibleItemCount
+    }
+}
+//! [contentItem]
diff --git a/src/imports/controls/doc/snippets/qtquickcontrols2-tumbler-timePicker.qml b/src/imports/controls/doc/snippets/qtquickcontrols2-tumbler-timePicker.qml
new file mode 100644
index 00000000..e62238ca
--- /dev/null
+++ b/src/imports/controls/doc/snippets/qtquickcontrols2-tumbler-timePicker.qml
@@ -0,0 +1,103 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the test suite 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$
+**
+****************************************************************************/
+
+//! [tumbler]
+import QtQuick 2.8
+import QtQuick.Window 2.2
+import QtQuick.Controls 2.1
+
+Rectangle {
+    width: frame.implicitWidth + 10
+    height: frame.implicitHeight + 10
+
+    function formatText(count, modelData) {
+        var data = count === 12 ? modelData + 1 : modelData;
+        return data.toString().length < 2 ? "0" + data : data;
+    }
+
+    FontMetrics {
+        id: fontMetrics
+    }
+
+    Component {
+        id: delegateComponent
+
+        Label {
+            text: formatText(Tumbler.tumbler.count, modelData)
+            opacity: 1.0 - Math.abs(Tumbler.displacement) / (Tumbler.tumbler.visibleItemCount / 2)
+            horizontalAlignment: Text.AlignHCenter
+            verticalAlignment: Text.AlignVCenter
+            font.pixelSize: fontMetrics.font.pixelSize * 1.25
+        }
+    }
+
+    Frame {
+        id: frame
+        padding: 0
+        anchors.centerIn: parent
+
+        Row {
+            id: row
+
+            Tumbler {
+                id: hoursTumbler
+                visibleItemCount: 5
+                model: 12
+                delegate: delegateComponent
+            }
+
+            Tumbler {
+                id: minutesTumbler
+                visibleItemCount: 5
+                model: 60
+                delegate: delegateComponent
+            }
+
+            Tumbler {
+                id: amPmTumbler
+                visibleItemCount: 5
+                wrap: false
+                model: ["AM", "PM"]
+                delegate: delegateComponent
+            }
+        }
+    }
+}
+//! [tumbler]
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc
index 559c89f0..a60969c0 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc
@@ -697,4 +697,13 @@
         \image qtquickcontrols2-tumbler-custom.png
 
         \snippet qtquickcontrols2-tumbler-custom.qml file
+
+        If you want to define your own contentItem, use either a \l ListView or
+        \l PathView as the root item. For a wrapping Tumbler, use PathView:
+
+        \snippet qtquickcontrols2-tumbler-pathView.qml contentItem
+
+        For a non-wrapping Tumbler, use ListView:
+
+        \snippet qtquickcontrols2-tumbler-listView.qml contentItem
 */
diff --git a/src/imports/controls/material/Tumbler.qml b/src/imports/controls/material/Tumbler.qml
index 7e914319..3587ea42 100644
--- a/src/imports/controls/material/Tumbler.qml
+++ b/src/imports/controls/material/Tumbler.qml
@@ -35,8 +35,9 @@
 ****************************************************************************/
 
 import QtQuick 2.6
-import QtQuick.Controls 2.0
-import QtQuick.Templates 2.0 as T
+import QtQuick.Controls 2.1
+import QtQuick.Controls.impl 2.1
+import QtQuick.Templates 2.1 as T
 import QtQuick.Controls.Material 2.0
 
 T.Tumbler {
@@ -54,22 +55,16 @@ T.Tumbler {
         verticalAlignment: Text.AlignVCenter
     }
 
-    contentItem: PathView {
-        id: pathView
+    contentItem: TumblerView {
+        id: tumblerView
         model: control.model
         delegate: control.delegate
-        clip: true
-        pathItemCount: control.visibleItemCount + 1
-        preferredHighlightBegin: 0.5
-        preferredHighlightEnd: 0.5
-        dragMargin: width / 2
-
         path: Path {
-            startX: pathView.width / 2
-            startY: -pathView.delegateHeight / 2
+            startX: tumblerView.width / 2
+            startY: -tumblerView.delegateHeight / 2
             PathLine {
-                x: pathView.width / 2
-                y: pathView.pathItemCount * pathView.delegateHeight - pathView.delegateHeight / 2
+                x: tumblerView.width / 2
+                y: (control.visibleItemCount + 1) * tumblerView.delegateHeight - tumblerView.delegateHeight / 2
             }
         }
 
diff --git a/src/imports/controls/plugins.qmltypes b/src/imports/controls/plugins.qmltypes
index e661056c..c8cde812 100644
--- a/src/imports/controls/plugins.qmltypes
+++ b/src/imports/controls/plugins.qmltypes
@@ -2055,7 +2055,7 @@ Module {
         name: "QQuickTumbler"
         defaultProperty: "data"
         prototype: "QQuickControl"
-        exports: ["QtQuick.Templates/Tumbler 2.0"]
+        exports: ["QtQuick.Templates/Tumbler 2.1"]
         exportMetaObjectRevisions: [0]
         attachedType: "QQuickTumblerAttached"
         Property { name: "model"; type: "QVariant" }
@@ -2064,6 +2064,7 @@ Module {
         Property { name: "currentItem"; type: "QQuickItem"; isReadonly: true; isPointer: true }
         Property { name: "delegate"; type: "QQmlComponent"; isPointer: true }
         Property { name: "visibleItemCount"; type: "int" }
+        Property { name: "wrap"; type: "bool" }
     }
     Component {
         name: "QQuickTumblerAttached"
diff --git a/src/imports/controls/qtquickcontrols2plugin.cpp b/src/imports/controls/qtquickcontrols2plugin.cpp
index 84c17267..4cfbd340 100644
--- a/src/imports/controls/qtquickcontrols2plugin.cpp
+++ b/src/imports/controls/qtquickcontrols2plugin.cpp
@@ -49,6 +49,7 @@
 #include <QtQuickControls2/private/qquickstyleplugin_p.h>
 #include <QtQuickControls2/private/qquickstyleselector_p.h>
 #include <QtQuickControls2/private/qquickcolorimageprovider_p.h>
+#include <QtQuickControls2/private/qquicktumblerview_p.h>
 
 #include "qquickbusyindicatorring_p.h"
 #include "qquickdialring_p.h"
@@ -142,6 +143,7 @@ void QtQuickControls2Plugin::registerTypes(const char *uri)
     qmlRegisterType(selector.select(QStringLiteral("Slider.qml")), uri, 2, 1, "Slider");
     qmlRegisterType(selector.select(QStringLiteral("StackView.qml")), uri, 2, 1, "StackView");
     qmlRegisterType(selector.select(QStringLiteral("SwipeView.qml")), uri, 2, 1, "SwipeView");
+    qmlRegisterType(selector.select(QStringLiteral("Tumbler.qml")), uri, 2, 1, "Tumbler");
 }
 
 void QtQuickControls2Plugin::initializeEngine(QQmlEngine *engine, const char *uri)
@@ -156,6 +158,7 @@ void QtQuickControls2Plugin::initializeEngine(QQmlEngine *engine, const char *ur
     qmlRegisterType<QQuickProgressStrip>(import, 2, 0, "ProgressStrip");
     qmlRegisterType<QQuickProgressAnimator>(import, 2, 0, "ProgressStripAnimator");
     qmlRegisterType<QQuickDialRing>(import, 2, 0, "DialRing");
+    qmlRegisterType<QQuickTumblerView>(import, 2, 1, "TumblerView");
 
     qmlRegisterType(typeUrl(QStringLiteral("CheckIndicator.qml")), import, 2, 0, "CheckIndicator");
     qmlRegisterType(typeUrl(QStringLiteral("RadioIndicator.qml")), import, 2, 0, "RadioIndicator");
diff --git a/src/imports/controls/universal/Tumbler.qml b/src/imports/controls/universal/Tumbler.qml
index 7b134b84..ead3a9d3 100644
--- a/src/imports/controls/universal/Tumbler.qml
+++ b/src/imports/controls/universal/Tumbler.qml
@@ -35,9 +35,10 @@
 ****************************************************************************/
 
 import QtQuick 2.6
-import QtQuick.Templates 2.0 as T
+import QtQuick.Templates 2.1 as T
 import QtQuick.Controls.Universal 2.0
-import QtQuick.Controls 2.0
+import QtQuick.Controls 2.1
+import QtQuick.Controls.impl 2.1
 
 T.Tumbler {
     id: control
@@ -54,22 +55,16 @@ T.Tumbler {
         verticalAlignment: Text.AlignVCenter
     }
 
-    contentItem: PathView {
-        id: pathView
+    contentItem: TumblerView {
+        id: tumblerView
         model: control.model
         delegate: control.delegate
-        clip: true
-        pathItemCount: control.visibleItemCount + 1
-        preferredHighlightBegin: 0.5
-        preferredHighlightEnd: 0.5
-        dragMargin: width / 2
-
         path: Path {
-            startX: pathView.width / 2
-            startY: -pathView.delegateHeight / 2
+            startX: tumblerView.width / 2
+            startY: -tumblerView.delegateHeight / 2
             PathLine {
-                x: pathView.width / 2
-                y: pathView.pathItemCount * pathView.delegateHeight - pathView.delegateHeight / 2
+                x: tumblerView.width / 2
+                y: (control.visibleItemCount + 1) * tumblerView.delegateHeight - tumblerView.delegateHeight / 2
             }
         }
 
diff --git a/src/imports/templates/qtquicktemplates2plugin.cpp b/src/imports/templates/qtquicktemplates2plugin.cpp
index 07a4653f..28162e61 100644
--- a/src/imports/templates/qtquicktemplates2plugin.cpp
+++ b/src/imports/templates/qtquicktemplates2plugin.cpp
@@ -181,6 +181,7 @@ void QtQuickTemplates2Plugin::registerTypes(const char *uri)
     qmlRegisterType<QQuickSlider, 1>(uri, 2, 1, "Slider");
     qmlRegisterType<QQuickStackView, 1>(uri, 2, 1, "StackView");
     qmlRegisterType<QQuickSwipeView, 1>(uri, 2, 1, "SwipeView");
+    qmlRegisterType<QQuickTumbler, 1>(uri, 2, 1, "Tumbler");
 }
 
 QT_END_NAMESPACE