Use a ScrollHelper to fix scrolling on listviews

Because the standard scrolling is so unusable depending on the input
device we replace it by something custom that is fairly similar to what
QQC1 ScrollView did. Using a ScrollView sucks in many ways, including
that you have to wrap all sorts of things which is just code wise not
great at all. The ScrollHelper can instead be attached to any existing
flickable to override it's scrolling behaviour, so we can also silently
drop it once the default flickable behaviour starts to make sense.

3 files changed, 100 insertions, 26 deletions

diff --git a/framework/qml/ListView.qml b/framework/qml/ListView.qml
index f137d03e..161fe48e 100644
--- a/framework/qml/ListView.qml
+++ b/framework/qml/ListView.qml
@@ -19,37 +19,14 @@
 
 import QtQuick 2.7
 import QtQuick.Controls 2
+import org.kube.framework 1.0 as Kube
 
 ListView {
     id: root
-    property var focusProxy: root
 
-    /*
-     * The MouseArea + interactive: false + maximumFlickVelocity are required
-     * to fix scrolling for desktop systems where we don't want flicking behaviour.
-     *
-     * See also:
-     * ScrollView.qml in qtquickcontrols
-     * qquickwheelarea.cpp in qtquickcontrols
-     */
-    MouseArea {
+    Kube.ScrollHelper {
+        flickable: root
         anchors.fill: root
-        propagateComposedEvents: true
-
-        onWheel: {
-            //Some trackpads (mine) emit 0 events in between that we can safely ignore.
-            if (wheel.pixelDelta.y) {
-                //120 is apparently the factor used in windows(https://chromium.googlesource.com/chromium/src/+/70763eb93a32555910a3b4269aeec51252ab9ec6/ui/events/event.cc)
-                listView.flick(0, wheel.pixelDelta.y * 120)
-            } else if (wheel.angleDelta.y) {
-                //Arbitrary but this seems to work for me...
-                listView.flick(0, wheel.angleDelta.y * 10)
-            }
-        }
     }
-    interactive: false
-    maximumFlickVelocity: 100000
-
-    boundsBehavior: Flickable.StopAtBounds
 }
 
diff --git a/framework/qml/ScrollHelper.qml b/framework/qml/ScrollHelper.qml
new file mode 100644
index 00000000..b2f91201
--- /dev/null
+++ b/framework/qml/ScrollHelper.qml
@@ -0,0 +1,96 @@
+/*
+ *  Copyright (C) 2016 Michael Bohlender, <michael.bohlender@kdemail.net>
+ *  Copyright (C) 2017 Christian Mollekopf, <mollekopf@kolabsystems.com>
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License along
+ *  with this program; if not, write to the Free Software Foundation, Inc.,
+ *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+
+import QtQuick 2.7
+import QtQuick.Controls 2
+import org.kube.framework 1.0 as Kube
+
+/*
+* The MouseArea + interactive: false + maximumFlickVelocity are required
+* to fix scrolling for desktop systems where we don't want flicking behaviour.
+*
+* See also:
+* ScrollView.qml in qtquickcontrols
+* qquickwheelarea.cpp in qtquickcontrols
+*/
+MouseArea {
+    id: root
+    propagateComposedEvents: true
+
+    property Flickable flickable
+
+    //Place the mouse area under the flickable
+    z: -1
+    onFlickableChanged: {
+        flickable.interactive = false
+        flickable.maximumFlickVelocity = 100000
+        flickable.boundsBehavior = Flickable.StopAtBounds
+        root.parent = flickable
+    }
+
+    function calculateNewPosition(flickableItem, wheel) {
+        //Nothing to scroll
+        if (flickableItem.contentHeight < flickableItem.height) {
+            return flickableItem.contentY;
+        }
+        //Ignore 0 events (happens at least with Christians trackpad)
+        if (wheel.pixelDelta.y == 0 && wheel.angleDelta.y == 0) {
+            return flickableItem.contentY;
+        }
+        //pixelDelta seems to be the same as angleDelta/8
+        var pixelDelta = wheel.pixelDelta.y != 0 ? wheel.pixelDelta.y : wheel.angleDelta.y / 8
+
+        var y = pixelDelta
+        if (!y) {
+            return flickableItem.contentY;
+        }
+
+        var minYExtent = flickableItem.originY + flickableItem.topMargin;
+        var maxYExtent = (flickableItem.contentHeight + flickableItem.bottomMargin + flickableItem.originY) - flickableItem.height;
+
+        if (typeof(flickableItem.headerItem) !== "undefined" && flickableItem.headerItem) {
+            minYExtent += flickableItem.headerItem.height
+        }
+
+        //Avoid overscrolling
+        return Math.max(minYExtent, Math.min(maxYExtent, flickableItem.contentY - y));
+    }
+
+    onWheel: {
+        var newPos = calculateNewPosition(flickable, wheel);
+        // console.warn("Delta: ", wheel.pixelDelta.y);
+        // console.warn("Old position: ", flickable.contentY);
+        // console.warn("New position: ", newPos);
+
+        // Show the scrollbars
+        flickable.flick(0, 0);
+        flickable.contentY = newPos;
+        cancelFlickStateTimer.start()
+    }
+
+
+    Timer {
+        id: cancelFlickStateTimer
+        //How long the scrollbar will remain visible
+        interval: 500
+        // Hide the scrollbars
+        onTriggered: listView.cancelFlick();
+    }
+}
+
diff --git a/framework/qmldir b/framework/qmldir
index b8e7345f..04893ec9 100644
--- a/framework/qmldir
+++ b/framework/qmldir
@@ -30,6 +30,7 @@ View 1.0 View.qml
 AutocompleteLineEdit 1.0 AutocompleteLineEdit.qml
 AttachmentDelegate 1.0 AttachmentDelegate.qml
 ListView 1.0 ListView.qml
+ScrollHelper 1.0 ScrollHelper.qml
 singleton Messages 1.0 Messages.qml
 singleton Colors 1.0 Colors.qml
 singleton Icons 1.0 Icons.qml