Ubuntu UI Toolkit

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

77-pressandhold
Merge into staging

Proposed by Zsombor Egri on 2015-01-19

Status:	Merged
Approved by:	Tim Peeters on 2015-01-22
Approved revision:	1383
Merged at revision:	1387
Proposed branch:	lp:~zsombi/ubuntu-ui-toolkit/77-pressandhold
Merge into:	lp:ubuntu-ui-toolkit/staging
Diff against target:	328 lines (+130/-8) 6 files modified components.api (+1/-0) modules/Ubuntu/Components/plugin/uclistitem.cpp (+56/-6) modules/Ubuntu/Components/plugin/uclistitem.h (+2/-0) modules/Ubuntu/Components/plugin/uclistitem_p.h (+3/-0) tests/resources/listitems/ListItemTest.qml (+8/-2) tests/unit_x11/tst_components/tst_listitem.qml (+60/-0)
To merge this branch:	bzr merge lp:~zsombi/ubuntu-ui-toolkit/77-pressandhold
Related bugs:	Link a bug report
Related blueprints:	SDK: Design a new ListItem and layouts (Undefined)

Reviewer	Review Type	Date Requested	Status
PS Jenkins bot	continuous-integration		Approve on 2015-01-22
Tim Peeters		2015-01-19	Approve on 2015-01-22
Review via email: mp+246940@code.launchpad.net

Commit message

Introducing pressAndHold signal into ListItem.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-20:

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

review: Needs Fixing (continuous-integration)

lp:~zsombi/ubuntu-ui-toolkit/77-pressandhold updated on 2015-01-21

1381. By Zsombor Egri on 2015-01-21: staging sync

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-21:

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

review: Needs Fixing (continuous-integration)

lp:~zsombi/ubuntu-ui-toolkit/77-pressandhold updated on 2015-01-22

1382. By Zsombor Egri on 2015-01-22: staging sync

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-22:

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Tim Peeters (tpeeters) wrote on 2015-01-22:

If you press on a list item without actions, and then start dragging, the long-press still takes effect. This was not totally expected for me, but I tested the MouseArea behavior and that is the same. Nice! :)

When I long-press on a list item with actions it works fine (and it doesn't trigger when dragging the actions).

Revision history for this message

Tim Peeters (tpeeters) wrote on 2015-01-22:

82 + * onPressAndHold: console.log("clicked on ListItem with onPressAndHold implemented")

"clicked" should be "long-pressed" ;)

Revision history for this message

Tim Peeters (tpeeters) wrote on 2015-01-22:

105 + * The signal is emitted when the list item is long pressed. When a slot is connected,
106 + * no \l clicked signal will be emitted, similarly to MouseArea's pressAndHold.

shouldn't that be "When a slot is triggered,"? Connected seems misleading here.

lp:~zsombi/ubuntu-ui-toolkit/77-pressandhold updated on 2015-01-22

1383. By Zsombor Egri on 2015-01-22: review comments applied

Revision history for this message

Tim Peeters (tpeeters) wrote on 2015-01-22:

great, thanks!

review: Approve

Revision history for this message

PS Jenkins bot (ps-jenkins) on 2015-01-22:

review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Dan Chapman 

Tom Mirmar

Ubuntu SDK team

Zsombor Egri

 === modified file 'components.api'
 --- components.api	2015-01-22 06:15:59 +0000
 +++ components.api	2015-01-22 11:34:38 +0000
@@ -882,6 +882,7 @@
      Property { name: "style"; type: "QQmlComponent"; isPointer: true }
      Property { name: "__styleInstance"; type: "QQuickItem"; isReadonly: true; isPointer: true }
      Signal { name: "clicked" }
++    Signal { name: "pressAndHold" }
      Signal { name: "contentMovementStarted" }
      Signal { name: "contentMovementEnded" }
      name: "UCListItemActions"
 === modified file 'modules/Ubuntu/Components/plugin/uclistitem.cpp'
 --- modules/Ubuntu/Components/plugin/uclistitem.cpp	2015-01-20 10:24:08 +0000
 +++ modules/Ubuntu/Components/plugin/uclistitem.cpp	2015-01-22 11:34:38 +0000
@@ -28,6 +28,8 @@
  #include <QtQuick/private/qquickitem_p.h>
  #include <QtQuick/private/qquickflickable_p.h>
  #include <QtQuick/private/qquickpositioners_p.h>
++#include <QtGui/QGuiApplication>
++#include <QtGui/QStyleHints>
  #include <QtQuick/private/qquickanimation_p.h>
  #include <QtQuick/private/qquickmousearea_p.h>
  #include "uclistitemstyle.h"
@@ -395,6 +397,14 @@
      return QObjectPrivate::get(q)->isSignalConnected(signalIdx);
+ }
++bool UCListItemPrivate::isPressAndHoldConnected()
++{
++    Q_Q(UCListItem);
++    static QMetaMethod method = QMetaMethod::fromSignal(&UCListItem::pressAndHold);
++    static int signalIdx = QMetaObjectPrivate::signalIndex(method);
++    return QObjectPrivate::get(q)->isSignalConnected(signalIdx);
++}
++
  void UCListItemPrivate::_q_updateThemedData()
+ {
      Q_Q(UCListItem);
@@ -593,7 +603,8 @@
     // action, leading or trailing actions list or at least an active child component declared
     QQuickMouseArea *ma = q->findChild<QQuickMouseArea*>();
     bool activeMouseArea = ma && ma->isEnabled();
--   return !activeComponent && (isClickedConnected() || leadingActions || trailingActions || activeMouseArea);
++   return !activeComponent && (isClickedConnected() || isPressAndHoldConnected() ||
++                               leadingActions || trailingActions || activeMouseArea);
+ }
  // set highlighted flag and update contentItem
@@ -604,6 +615,12 @@
          suppressClick = false;
          Q_Q(UCListItem);
          q->update();
++        if (highlighted) {
++            // start pressandhold timer
++            pressAndHoldTimer.start(QGuiApplication::styleHints()->mousePressAndHoldInterval(), q);
++        } else {
++            pressAndHoldTimer.stop();
++        }
          Q_EMIT q->highlightedChanged();
+     }
+ }
@@ -697,9 +714,9 @@
   * properties. The list item is highlighted if there is an action attached to it.
   * This means that the list item must have an active component declared as child,
   * at least leading- or trailing actions specified, or to have a slot connected to
-- * \l clicked signal. In any other case the component will not be highlighted, and
-- * \l highlighted property will not be toggled either. Also, there will be no highlight
-- * happening if the click happens on the active component.
++ * \l clicked or \l pressAndHold signal. In any other case the component will not
++ * be highlighted, and \l highlighted property will not be toggled either. Also,
++ * there will be no highlight happening if the click happens on the active component.
   * \qml
   * import QtQuick 2.3
   * import Ubuntu.Components 1.2
@@ -744,6 +761,12 @@
   *        }
   *        ListItem {
   *            Label {
++ *                text: "onPressAndHold implemented"
++ *            }
++ *            onPressAndHold: console.log("long-pressed on ListItem with onPressAndHold implemented")
++ *        }
++ *        ListItem {
++ *            Label {
   *                text: "No highlight"
   *            }
   *        }
@@ -825,11 +848,22 @@
  /*!
   * \qmlsignal ListItem::clicked()
-- *
   * The signal is emitted when the component gets released while the \l highlighted property
   * is set. The signal is not emitted if the ListItem content is swiped or when used in
   * Flickable (or ListView, GridView) and the Flickable gets moved.
-- */
++ *
++ * If the ListItem contains a component which contains a MouseArea, the clicked
++ * signal will be supressed.
++ */
++
++/*!
++ * \qmlsignal ListItem::pressAndHold()
++ * The signal is emitted when the list item is long pressed.
++ *
++ * If the ListItem contains a component which contains a MouseArea, the pressAndHold
++ * signal will be supressed.
++ */
++
  UCListItem::UCListItem(QQuickItem *parent)
      : UCStyledItemBase(*(new UCListItemPrivate), parent)
+ {
@@ -1073,6 +1107,8 @@
          d->lastPos = event->localPos();
          if (dx) {
++            // stop pressAndHold timer as we started to drag
++            d->pressAndHoldTimer.stop();
              d->setContentMoving(true);
              // clamp X into allowed dragging area
              d->clampAndMoveX(x, dx);
@@ -1146,6 +1182,20 @@
      return UCStyledItemBase::eventFilter(target, event);
+ }
++void UCListItem::timerEvent(QTimerEvent *event)
++{
++    Q_D(UCListItem);
++    if (event->timerId() == d->pressAndHoldTimer.timerId() && d->highlighted) {
++        d->pressAndHoldTimer.stop();
++        if (isEnabled() && d->isPressAndHoldConnected()) {
++            d->suppressClick = true;
++            Q_EMIT pressAndHold();
++        }
++    } else {
++        QQuickItem::timerEvent(event);
++    }
++}
++
  /*!
   * \qmlproperty ListItemActions ListItem::leadingActions
+  *
 === modified file 'modules/Ubuntu/Components/plugin/uclistitem.h'
 --- modules/Ubuntu/Components/plugin/uclistitem.h	2015-01-12 15:44:59 +0000
 +++ modules/Ubuntu/Components/plugin/uclistitem.h	2015-01-22 11:34:38 +0000
@@ -78,6 +78,7 @@
      void mouseMoveEvent(QMouseEvent *event);
      bool childMouseEventFilter(QQuickItem *child, QEvent *event);
      bool eventFilter(QObject *, QEvent *);
++    void timerEvent(QTimerEvent *event);
  Q_SIGNALS:
      void leadingActionsChanged();
@@ -90,6 +91,7 @@
      void listItemChildrenChanged();
      void clicked();
++    void pressAndHold();
      void styleChanged();
      void __styleInstanceChanged();
 === modified file 'modules/Ubuntu/Components/plugin/uclistitem_p.h'
 --- modules/Ubuntu/Components/plugin/uclistitem_p.h	2015-01-12 15:44:59 +0000
 +++ modules/Ubuntu/Components/plugin/uclistitem_p.h	2015-01-22 11:34:38 +0000
@@ -20,6 +20,7 @@
  #include "uclistitem.h"
  #include "ucstyleditembase_p.h"
  #include <QtCore/QPointer>
++#include <QtCore/QBasicTimer>
  #include <QtQuick/private/qquickrectangle_p.h>
  #define MIN(x, y)           ((x < y) ? x : y)
@@ -54,6 +55,7 @@
+     }
      bool isClickedConnected();
++    bool isPressAndHoldConnected();
      void _q_updateThemedData();
      void _q_rebound();
      void promptRebound();
@@ -79,6 +81,7 @@
      bool flicked:1;
      qreal xAxisMoveThresholdGU;
      qreal overshoot;
++    QBasicTimer pressAndHoldTimer;
      QPointF lastPos;
      QPointF pressedPos;
      QColor color;
 === modified file 'tests/resources/listitems/ListItemTest.qml'
 --- tests/resources/listitems/ListItemTest.qml	2015-01-12 07:58:55 +0000
 +++ tests/resources/listitems/ListItemTest.qml	2015-01-22 11:34:38 +0000
@@ -96,16 +96,21 @@
                  print("click")
                  main.override = !main.override
+             }
++            onPressAndHold: print("pressAndHold", objectName)
              Label {
                  anchors.fill: parent
                  text: units.gridUnit + "PX/unit"
+             }
++            Button {
++                text: "Press me"
++                anchors.centerIn: parent
++            }
++
              leadingActions: ListItemActions {
                  objectName: "InlineLeading"
                  actions: [stock]
                  delegate: Column {
                      width: height + units.gu(2)
--                    anchors.verticalCenter: parent.verticalCenter
                      Icon {
                          width: units.gu(3)
                          height: width
@@ -149,12 +154,13 @@
              clip: true
              width: parent.width
              height: units.gu(20)
--            model: 10
++            model: 25
              pressDelay: 0
              delegate: ListItem {
                  objectName: "ListItem" + index
                  id: listItem
                  onClicked: print(" clicked")
++                onPressAndHold: print("pressAndHold")
                  leadingActions: leading
                  trailingActions: leadingActions
                  Label {
 === modified file 'tests/unit_x11/tst_components/tst_listitem.qml'
 --- tests/unit_x11/tst_components/tst_listitem.qml	2015-01-16 14:08:06 +0000
 +++ tests/unit_x11/tst_components/tst_listitem.qml	2015-01-22 11:34:38 +0000
@@ -78,6 +78,7 @@
          ListItem {
              id: clickedConnected
              onClicked: {}
++            onPressAndHold: {}
+         }
          ListItem {
              id: testItem
@@ -174,6 +175,8 @@
              highlightedSpy.clear();
              clickSpy.clear();
              actionSpy.clear();
++            pressAndHoldSpy.clear();
++            buttonSpy.clear();
              interactiveSpy.clear();
              listView.interactive = true;
              // make sure we collapse
@@ -235,10 +238,12 @@
+         }
          function test_clicked_on_mouse() {
++            clickSpy.target = testItem;
              mouseClick(testItem, testItem.width / 2, testItem.height / 2);
              clickSpy.wait();
+         }
          function test_clicked_on_tap() {
++            clickSpy.target = testItem;
              TestExtras.touchClick(0, testItem, centerOf(testItem));
              clickSpy.wait();
+         }
@@ -612,5 +617,60 @@
                  compare(highlightedSpy.count, 0, "Should not be highlighted!");
+             }
+         }
++
++        SignalSpy {
++            id: pressAndHoldSpy
++            signalName: "pressAndHold"
++        }
++        SignalSpy {
++            id: buttonSpy
++            signalName: "clicked"
++            target: button
++        }
++        function test_pressandhold_suppress_click() {
++            var center = centerOf(testItem);
++            pressAndHoldSpy.target = testItem;
++            clickSpy.target = testItem;
++            clickSpy.clear();
++            mouseLongPress(testItem, center.x, center.y);
++            mouseRelease(testItem, center.x, center.y);
++            pressAndHoldSpy.wait();
++            compare(clickSpy.count, 0, "Click must be suppressed when long pressed");
++        }
++
++        function test_pressandhold_not_emitted_when_swiped() {
++            var center = centerOf(testItem);
++            pressAndHoldSpy.target = testItem;
++            // move mouse slowly from left to right, the swipe threshold is 1.5 GU!!!,
++            // so any value less than that will emit pressAndHold
++            mouseMoveSlowly(testItem, center.x, center.y, units.gu(2), 0, 10, 100);
++            mouseRelease(testItem, center.x + units.gu(1), center.y);
++            compare(pressAndHoldSpy.count, 0, "pressAndHold should not be emitted!");
++            // make sure we have collapsed item
++            rebound(testItem);
++        }
++
++        function test_pressandhold_not_emitted_when_pressed_over_active_component() {
++            var press = centerOf(button);
++            pressAndHoldSpy.target = controlItem;
++            mouseLongPress(button, press.x, press.y);
++            compare(pressAndHoldSpy.count, 0, "")
++            mouseRelease(button, press.x, press.y);
++        }
++
++        function test_click_on_button_suppresses_listitem_click() {
++            buttonSpy.target = button;
++            clickSpy.target = controlItem;
++            mouseClick(button, centerOf(button).x, centerOf(button).y);
++            buttonSpy.wait();
++            compare(clickSpy.count, 0, "ListItem clicked() must be suppressed");
++        }
++
++        function test_pressandhold_connected_causes_highlight() {
++            highlightedSpy.target = clickedConnected;
++            mouseLongPress(clickedConnected, centerOf(clickedConnected).x, centerOf(clickedConnected).y);
++            highlightedSpy.wait();
++            mouseRelease(clickedConnected, centerOf(clickedConnected).x, centerOf(clickedConnected).y);
++        }
+     }
+ }

Ubuntu UI Toolkit

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

Commit message

Description of the change

Preview Diff

Subscribers