Merge lp:~zsombi/ubuntu-ui-toolkit/listItemContentDrag into lp:ubuntu-ui-toolkit/staging

[Zsombor Egri]

Add ListItem.swipeEnabled property to block swiping when overlay MouseArea is used to drag content. Fixes swiping when leading/trailing actions list is empty.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1704
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/2420/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/1148
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/1150
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/1150/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/1147

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/2420/rebuild

review: Approve (continuous-integration)

[Cris Dywan (kalikiana)]

Nice!

review: Approve

=== modified file 'components.api'
--- components.api	2015-10-23 05:42:14 +0000
+++ components.api	2015-10-26 11:51:01 +0000
@@ -514,6 +514,7 @@
     signal contentMovementEnded()
     property bool selectMode
     property bool selected
+    property bool swipeEnabled 1.3
     property ListItemActions trailingActions
 Ubuntu.Components.ListItemActions 1.2: QtObject
     readonly property Action actions

=== modified file 'src/Ubuntu/Components/plugin/uclistitem.cpp'
--- src/Ubuntu/Components/plugin/uclistitem.cpp	2015-10-20 11:05:53 +0000
+++ src/Ubuntu/Components/plugin/uclistitem.cpp	2015-10-26 11:51:01 +0000
@@ -198,6 +198,7 @@
     , xAxisMoveThresholdGU(DEFAULT_SWIPE_THRESHOLD_GU)
     , button(Qt::NoButton)
     , highlighted(false)
+    , swipeEnabled(true)
     , contentMoved(false)
     , swiped(false)
     , suppressClick(false)
@@ -1255,10 +1256,15 @@
 // returns true if the mouse is swiped over the threshold value
 bool UCListItemPrivate::swipedOverThreshold(const QPointF &mousePos, const QPointF relativePos)
 {
+    if ((!leadingActions || UCListItemActionsPrivate::get(leadingActions)->actions.size() <= 0) &&
+        (!trailingActions || UCListItemActionsPrivate::get(trailingActions)->actions.size() <= 0))
+    {
+        return false;
+    }
     qreal threshold = UCUnits::instance().gu(xAxisMoveThresholdGU);
     qreal mouseX = mousePos.x();
     qreal pressedX = relativePos.x();
-    return ((mouseX < (pressedX - threshold)) || (mouseX > (pressedX + threshold)));
+    return swipeEnabled && ((mouseX < (pressedX - threshold)) || (mouseX > (pressedX + threshold)));
 }
 
 void UCListItem::mouseMoveEvent(QMouseEvent *event)
@@ -1273,7 +1279,7 @@
 
     // accept the tugging only if the move is within the threshold
     // use saved button because MouseMove has no button() and buttons() isn't reliable
-    if (d->button == Qt::LeftButton && d->highlighted && !d->swiped && (d->leadingActions || d->trailingActions)) {
+    if (d->button == Qt::LeftButton && d->highlighted && !d->swiped) {
         // check if we can initiate the drag at all
         // only X direction matters, if Y-direction leaves the threshold, but X not, the tug is not valid
         if (d->swipedOverThreshold(event->localPos(), d->pressedPos)) {
@@ -1797,4 +1803,49 @@
     }
 }
 
+/*!
+ * \qmlproperty bool ListItem::swipeEnabled
+ * \since Ubuntu.Components 1.3
+ * The property enables the swiping of the leading- or trailing actions. This
+ * is useful when an overlay component needs to handle mouse moves or drag events
+ * without the ListItem to steal the events. Defaults to true.
+ * \qml
+ * import QtQuick 2.4
+ * import Ubuntu.Components 1.3
+ *
+ * ListView {
+ *     width: units.gu(40)
+ *     height: units.gu(70)
+ *     model: 25
+ *     delegate: ListItem {
+ *         swipeEnabled: !mouseArea.drag.active
+ *         Rectangle {
+ *             color: "red"
+ *             width: units.gu(2)
+ *             height: width
+ *             MouseArea {
+ *                 id: mouseArea
+ *                 anchors.fill: parent
+ *                 drag.target: parent
+ *             }
+ *         }
+ *     }
+ * }
+ * \endqml
+ */
+bool UCListItem::isSwipeEnabled() const
+{
+    Q_D(const UCListItem);
+    return d->swipeEnabled;
+}
+void UCListItem::setSwipeEnabled(bool swipeEnabled)
+{
+    Q_D(UCListItem);
+    if (d->swipeEnabled == swipeEnabled) {
+        return;
+    }
+    d->swipeEnabled = swipeEnabled;
+    Q_EMIT swipeEnabledChanged();
+}
+
 #include "moc_uclistitem.cpp"

=== modified file 'src/Ubuntu/Components/plugin/uclistitem.h'
--- src/Ubuntu/Components/plugin/uclistitem.h	2015-09-23 14:31:26 +0000
+++ src/Ubuntu/Components/plugin/uclistitem.h	2015-10-26 11:51:01 +0000
@@ -47,6 +47,7 @@
     Q_CLASSINFO("DefaultProperty", "listItemData")
     // 1.3
     Q_PROPERTY(UCListItemExpansion* expansion READ expansion CONSTANT REVISION 1)
+    Q_PROPERTY(bool swipeEnabled READ isSwipeEnabled WRITE setSwipeEnabled NOTIFY swipeEnabledChanged FINAL REVISION 1)
 public:
     explicit UCListItem(QQuickItem *parent = 0);
     ~UCListItem();
@@ -65,6 +66,8 @@
     void resetHighlightColor();
     // 1.3
     UCListItemExpansion *expansion();
+    bool isSwipeEnabled() const;
+    void setSwipeEnabled(bool swipeEnabled);
 
 protected:
     virtual QObject *attachedViewItems(QObject *object, bool create);
@@ -92,6 +95,7 @@
     void selectModeChanged();
     void actionChanged();
     void listItemChildrenChanged();
+    Q_REVISION(1) void swipeEnabledChanged();
 
     void clicked();
     void pressAndHold();

=== modified file 'src/Ubuntu/Components/plugin/uclistitem_p.h'
--- src/Ubuntu/Components/plugin/uclistitem_p.h	2015-09-23 14:31:26 +0000
+++ src/Ubuntu/Components/plugin/uclistitem_p.h	2015-10-26 11:51:01 +0000
@@ -95,6 +95,7 @@
     qreal xAxisMoveThresholdGU;
     Qt::MouseButton button;
     bool highlighted:1;
+    bool swipeEnabled:1;
     bool contentMoved:1;
     bool swiped:1;
     bool suppressClick:1;

=== modified file 'tests/unit_x11/tst_components/tst_listitem_extras.qml'
--- tests/unit_x11/tst_components/tst_listitem_extras.qml	2015-09-18 10:49:07 +0000
+++ tests/unit_x11/tst_components/tst_listitem_extras.qml	2015-10-26 11:51:01 +0000
@@ -96,6 +96,28 @@
                 leadingActions: leading
             }
         }
+        ListItem {
+            id: emptyActionList
+            leadingActions: ListItemActions {}
+            trailingActions: ListItemActions {
+                actions: []
+            }
+        }
+        ListItem {
+            id: contentDragging
+            swipeEnabled: ma.drag.active
+            Rectangle {
+                id: draggedItem
+                width: units.gu(2)
+                height: width
+                color: "red"
+                MouseArea {
+                    id: ma
+                    anchors.fill: parent
+                    drag.target: parent
+                }
+            }
+        }
     }
 
     ListItemTestCase13 {
@@ -246,5 +268,64 @@
             }
             clickSpy.wait(200);
         }
+
+        function test_swipe_on_empty_actions_bug1500416_data() {
+            return [
+                {tag: "swipe leading, touch", item: emptyActionList, dx: units.gu(5), touch: true},
+                {tag: "swipe trailing, touch", item: emptyActionList, dx: -units.gu(5), touch: true},
+                {tag: "swipe leading, mouse", item: emptyActionList, dx: units.gu(5), touch: false},
+                {tag: "swipe trailing, mouse", item: emptyActionList, dx: -units.gu(5), touch: false}
+            ];
+        }
+        function test_swipe_on_empty_actions_bug1500416(data) {
+            setupSpy(data.item, "contentMovementEnded");
+            if (data.touch) {
+                tugNoWait(data.item, centerOf(data.item).x, centerOf(data.item).y, data.dx, 0);
+            } else {
+                swipeNoWait(data.item, centerOf(data.item).x, centerOf(data.item).y, data.dx, 0);
+            }
+            expectFailContinue(data.tag, "No swipe should happen");
+            spyWait(200);
+        }
+
+        function test_swipe_not_possible_when_swipe_disabled_data() {
+            listView.positionViewAtBeginning();
+            return [
+                {tag: "leading, touch", item: findChild(listView, "listItem0"), dx: units.gu(10), touch: true},
+                {tag: "trailing, touch", item: findChild(listView, "listItem0"), dx: -units.gu(10), touch: true},
+                {tag: "leading, mouse", item: findChild(listView, "listItem0"), dx: units.gu(10), touch: false},
+                {tag: "trailing, mouse", item: findChild(listView, "listItem0"), dx: -units.gu(10), touch: false},
+            ];
+        }
+        function test_swipe_not_possible_when_swipe_disabled(data) {
+            verify(data.item, "test item not found");
+            data.item.swipeEnabled = false;
+            setupSpy(data.item, "contentMovementEnded");
+            if (data.touch) {
+                tugNoWait(data.item, centerOf(data.item).x, centerOf(data.item).y, data.dx, 0);
+            } else {
+                swipeNoWait(data.item, centerOf(data.item).x, centerOf(data.item).y, data.dx, 0);
+            }
+            expectFailContinue(data.tag, "No swipe should happen");
+            spyWait(200);
+            data.item.swipeEnabled = true;
+        }
+
+        function test_drag_listitem_content_bug1500409_data() {
+            return [
+                {tag: "touch", touch: true},
+                {tag: "mouse", touch: false}
+            ];
+        }
+        function test_drag_listitem_content_bug1500409(data) {
+            setupSpy(contentDragging, "contentMovementStarted");
+            if (data.touch) {
+                TestExtras.touchDrag(0, draggedItem, centerOf(draggedItem), Qt.point(units.gu(10), units.gu(3)));
+            } else {
+                mouseDrag(draggedItem, centerOf(draggedItem).x, centerOf(draggedItem).y, units.gu(10), units.gu(3));
+            }
+            expectFailContinue("", "drag disables swipe");
+            spyWait(200);
+        }
     }
 }