Flickable small API changes.

- Split moving into movingHorizontally anf movingVertically
- Split flicking into flickingHorizontally and flickingVertically
- Rename flickDirection to flickableDirection
- onMovementStarted, onMovementEnded, onFlickStarted and onFlickEnded signals removed

Task-number: QTBUG-10572
Reviewed-by: Martin Jones

1 files changed, 122 insertions, 91 deletions

diff --git a/src/declarative/graphicsitems/qdeclarativeflickable.cpp b/src/declarative/graphicsitems/qdeclarativeflickable.cpp
index 34b0606..a7a8983 100644
--- a/src/declarative/graphicsitems/qdeclarativeflickable.cpp
+++ b/src/declarative/graphicsitems/qdeclarativeflickable.cpp
@@ -125,12 +125,14 @@ QDeclarativeFlickablePrivate::QDeclarativeFlickablePrivate()
   : viewport(new QDeclarativeItem)
     , hData(this, &QDeclarativeFlickablePrivate::setRoundedViewportX)
     , vData(this, &QDeclarativeFlickablePrivate::setRoundedViewportY)
-    , flicked(false), moving(false), stealMouse(false)
-    , pressed(false)
+    , flickingHorizontally(false), flickingVertically(false)
+    , hMoved(false), vMoved(false)
+    , movingHorizontally(false), movingVertically(false)
+    , stealMouse(false), pressed(false)
     , interactive(true), deceleration(500), maxVelocity(2000), reportedVelocitySmoothing(100)
     , delayedPressEvent(0), delayedPressTarget(0), pressDelay(0), fixupDuration(600)
     , vTime(0), visibleArea(0)
-    , flickDirection(QDeclarativeFlickable::AutoFlickDirection)
+    , flickableDirection(QDeclarativeFlickable::AutoFlickDirection)
     , boundsBehavior(QDeclarativeFlickable::DragAndOvershootBounds)
 {
 }
@@ -226,10 +228,15 @@ void QDeclarativeFlickablePrivate::flick(AxisData &data, qreal minExtent, qreal
         timeline.reset(data.move);
         timeline.accel(data.move, v, deceleration, maxDistance);
         timeline.callback(QDeclarativeTimeLineCallback(&data.move, fixupCallback, this));
-        if (!flicked) {
-            flicked = true;
-            emit q->flickingChanged();
-            emit q->flickStarted();
+        if (!flickingHorizontally && q->xflick()) {
+            flickingHorizontally = true;
+            emit q->flickingChanged(); // deprecated
+            emit q->flickingHorizontallyChanged();
+        }
+        if (!flickingVertically && q->yflick()) {
+            flickingVertically = true;
+            emit q->flickingChanged(); // deprecated
+            emit q->flickingVerticallyChanged();
         }
     } else {
         timeline.reset(data.move);
@@ -274,7 +281,6 @@ void QDeclarativeFlickablePrivate::fixup(AxisData &data, qreal minExtent, qreal
                 q->viewportMoved();
             }
         }
-        //emit flickingChanged();
     } else if (data.move.value() < maxExtent) {
         timeline.reset(data.move);
         if (fixupDuration) {
@@ -285,11 +291,7 @@ void QDeclarativeFlickablePrivate::fixup(AxisData &data, qreal minExtent, qreal
             data.move.setValue(maxExtent);
             q->viewportMoved();
         }
-        //emit flickingChanged();
-    } else {
-        flicked = false;
     }
-
     vTime = timeline.time();
 }
 
@@ -363,37 +365,6 @@ void QDeclarativeFlickablePrivate::updateBeginningEnd()
 */
 
 /*!
-    \qmlsignal Flickable::onMovementStarted()
-
-    This handler is called when the view begins moving due to user
-    interaction.
-*/
-
-/*!
-    \qmlsignal Flickable::onMovementEnded()
-
-    This handler is called when the view stops moving due to user
-    interaction.  If a flick was generated, this handler will
-    be triggered once the flick stops.  If a flick was not
-    generated, the handler will be triggered when the
-    user stops dragging - i.e. a mouse or touch release.
-*/
-
-/*!
-    \qmlsignal Flickable::onFlickStarted()
-
-    This handler is called when the view is flicked.  A flick
-    starts from the point that the mouse or touch is released,
-    while still in motion.
-*/
-
-/*!
-    \qmlsignal Flickable::onFlickEnded()
-
-    This handler is called when the view stops moving due to a flick.
-*/
-
-/*!
     \qmlproperty real Flickable::visibleArea.xPosition
     \qmlproperty real Flickable::visibleArea.widthRatio
     \qmlproperty real Flickable::visibleArea.yPosition
@@ -498,12 +469,14 @@ void QDeclarativeFlickable::setInteractive(bool interactive)
     Q_D(QDeclarativeFlickable);
     if (interactive != d->interactive) {
         d->interactive = interactive;
-        if (!interactive && d->flicked) {
+        if (!interactive && (d->flickingHorizontally || d->flickingVertically)) {
             d->timeline.clear();
             d->vTime = d->timeline.time();
-            d->flicked = false;
-            emit flickingChanged();
-            emit flickEnded();
+            d->flickingHorizontally = false;
+            d->flickingVertically = false;
+            emit flickingChanged(); // deprecated
+            emit flickingHorizontallyChanged();
+            emit flickingVerticallyChanged();
         }
         emit interactiveChanged();
     }
@@ -582,7 +555,7 @@ QDeclarativeFlickableVisibleArea *QDeclarativeFlickable::visibleArea()
 }
 
 /*!
-    \qmlproperty enumeration Flickable::flickDirection
+    \qmlproperty enumeration Flickable::flickableDirection
 
     This property determines which directions the view can be flicked.
 
@@ -596,21 +569,33 @@ QDeclarativeFlickableVisibleArea *QDeclarativeFlickable::visibleArea()
     \o Flickable.HorizontalAndVerticalFlick - allows flicking in both directions.
     \endlist
 */
-QDeclarativeFlickable::FlickDirection QDeclarativeFlickable::flickDirection() const
+QDeclarativeFlickable::FlickableDirection QDeclarativeFlickable::flickableDirection() const
 {
     Q_D(const QDeclarativeFlickable);
-    return d->flickDirection;
+    return d->flickableDirection;
 }
 
-void QDeclarativeFlickable::setFlickDirection(FlickDirection direction)
+void QDeclarativeFlickable::setFlickableDirection(FlickableDirection direction)
 {
     Q_D(QDeclarativeFlickable);
-    if (direction != d->flickDirection) {
-        d->flickDirection = direction;
-        emit flickDirectionChanged();
+    if (direction != d->flickableDirection) {
+        d->flickableDirection = direction;
+        emit flickableDirectionChanged();
     }
 }
 
+QDeclarativeFlickable::FlickableDirection QDeclarativeFlickable::flickDirection() const
+{
+    qmlInfo(this) << "'flickDirection' is deprecated. Please use 'flickableDirection' instead.";
+    return flickableDirection();
+}
+
+void QDeclarativeFlickable::setFlickDirection(FlickableDirection direction)
+{
+    qmlInfo(this) << "'flickDirection' is deprecated. Please use 'flickableDirection' instead.";
+    setFlickableDirection(direction);
+}
+
 void QDeclarativeFlickablePrivate::handleMousePressEvent(QGraphicsSceneMouseEvent *event)
 {
     if (interactive && timeline.isActive() && (qAbs(hData.velocity) > 10 || qAbs(vData.velocity) > 10))
@@ -626,7 +611,8 @@ void QDeclarativeFlickablePrivate::handleMousePressEvent(QGraphicsSceneMouseEven
     pressPos = event->pos();
     hData.pressPos = hData.move.value();
     vData.pressPos = vData.move.value();
-    flicked = false;
+    flickingHorizontally = false;
+    flickingVertically = false;
     QDeclarativeItemPrivate::start(pressTime);
     QDeclarativeItemPrivate::start(velocityTime);
 }
@@ -638,7 +624,6 @@ void QDeclarativeFlickablePrivate::handleMouseMoveEvent(QGraphicsSceneMouseEvent
         return;
     bool rejectY = false;
     bool rejectX = false;
-    bool moved = false;
 
     if (q->yflick()) {
         int dy = int(event->pos().y() - pressPos.y());
@@ -660,7 +645,7 @@ void QDeclarativeFlickablePrivate::handleMouseMoveEvent(QGraphicsSceneMouseEvent
             }
             if (!rejectY && stealMouse) {
                 vData.move.setValue(qRound(newY));
-                moved = true;
+                vMoved = true;
             }
             if (qAbs(dy) > QApplication::startDragDistance())
                 stealMouse = true;
@@ -687,7 +672,7 @@ void QDeclarativeFlickablePrivate::handleMouseMoveEvent(QGraphicsSceneMouseEvent
             }
             if (!rejectX && stealMouse) {
                 hData.move.setValue(qRound(newX));
-                moved = true;
+                hMoved = true;
             }
 
             if (qAbs(dx) > QApplication::startDragDistance())
@@ -717,7 +702,7 @@ void QDeclarativeFlickablePrivate::handleMouseMoveEvent(QGraphicsSceneMouseEvent
     if (rejectY) vData.velocity = 0;
     if (rejectX) hData.velocity = 0;
 
-    if (moved) {
+    if (hMoved || vMoved) {
         q->movementStarting();
         q->viewportMoved();
     }
@@ -812,9 +797,9 @@ void QDeclarativeFlickable::wheelEvent(QGraphicsSceneWheelEvent *event)
             d->vData.velocity = qMax(event->delta() - d->vData.smoothVelocity.value(), qreal(250.0));
         else
             d->vData.velocity = qMin(event->delta() - d->vData.smoothVelocity.value(), qreal(-250.0));
-        d->flicked = false;
+        d->flickingVertically = false;
         d->flickY(d->vData.velocity);
-        if (d->flicked)
+        if (d->flickingVertically)
             movementStarting();
         event->accept();
     } else if (xflick()) {
@@ -822,9 +807,9 @@ void QDeclarativeFlickable::wheelEvent(QGraphicsSceneWheelEvent *event)
             d->hData.velocity = qMax(event->delta() - d->hData.smoothVelocity.value(), qreal(250.0));
         else
             d->hData.velocity = qMin(event->delta() - d->hData.smoothVelocity.value(), qreal(-250.0));
-        d->flicked = false;
+        d->flickingHorizontally = false;
         d->flickX(d->hData.velocity);
-        if (d->flicked)
+        if (d->flickingHorizontally)
             movementStarting();
         event->accept();
     } else {
@@ -1091,7 +1076,7 @@ void QDeclarativeFlickable::setContentWidth(qreal w)
     else
         d->viewport->setWidth(w);
     // Make sure that we're entirely in view.
-    if (!d->pressed && !d->moving) {
+    if (!d->pressed && !d->movingHorizontally && !d->movingVertically) {
         int oldDuration = d->fixupDuration;
         d->fixupDuration = 0;
         d->fixupX();
@@ -1118,7 +1103,7 @@ void QDeclarativeFlickable::setContentHeight(qreal h)
     else
         d->viewport->setHeight(h);
     // Make sure that we're entirely in view.
-    if (!d->pressed && !d->moving) {
+    if (!d->pressed && !d->movingHorizontally && !d->movingVertically) {
         int oldDuration = d->fixupDuration;
         d->fixupDuration = 0;
         d->fixupY();
@@ -1149,17 +1134,17 @@ qreal QDeclarativeFlickable::vHeight() const
 bool QDeclarativeFlickable::xflick() const
 {
     Q_D(const QDeclarativeFlickable);
-    if (d->flickDirection == QDeclarativeFlickable::AutoFlickDirection)
+    if (d->flickableDirection == QDeclarativeFlickable::AutoFlickDirection)
         return vWidth() != width();
-    return d->flickDirection & QDeclarativeFlickable::HorizontalFlick;
+    return d->flickableDirection & QDeclarativeFlickable::HorizontalFlick;
 }
 
 bool QDeclarativeFlickable::yflick() const
 {
     Q_D(const QDeclarativeFlickable);
-    if (d->flickDirection == QDeclarativeFlickable::AutoFlickDirection)
+    if (d->flickableDirection == QDeclarativeFlickable::AutoFlickDirection)
         return vHeight() !=  height();
-    return d->flickDirection & QDeclarativeFlickable::VerticalFlick;
+    return d->flickableDirection & QDeclarativeFlickable::VerticalFlick;
 }
 
 bool QDeclarativeFlickable::sendMouseEvent(QGraphicsSceneMouseEvent *event)
@@ -1281,16 +1266,30 @@ void QDeclarativeFlickable::setFlickDeceleration(qreal deceleration)
     emit flickDecelerationChanged();
 }
 
+bool QDeclarativeFlickable::isFlicking() const
+{
+    Q_D(const QDeclarativeFlickable);
+    qmlInfo(this) << "'flicking' is deprecated. Please use 'flickingHorizontally' and 'flickingVertically' instead.";
+    return d->flickingHorizontally ||  d->flickingVertically;
+}
+
 /*!
-    \qmlproperty bool Flickable::flicking
+    \qmlproperty bool Flickable::flickingHorizontally
+    \qmlproperty bool Flickable::flickingVertically
 
-    This property holds whether the view is currently moving due to
-    the user flicking the view.
+    These properties hold whether the view is currently moving horizontally
+    or vertically due to the user flicking the view.
 */
-bool QDeclarativeFlickable::isFlicking() const
+bool QDeclarativeFlickable::isFlickingHorizontally() const
 {
     Q_D(const QDeclarativeFlickable);
-    return d->flicked;
+    return d->flickingHorizontally;
+}
+
+bool QDeclarativeFlickable::isFlickingVertically() const
+{
+    Q_D(const QDeclarativeFlickable);
+    return d->flickingVertically;
 }
 
 /*!
@@ -1319,40 +1318,72 @@ void QDeclarativeFlickable::setPressDelay(int delay)
     emit pressDelayChanged();
 }
 
+
+bool QDeclarativeFlickable::isMoving() const
+{
+    Q_D(const QDeclarativeFlickable);
+    qmlInfo(this) << "'moving' is deprecated. Please use 'movingHorizontally' or 'movingVertically' instead.";
+    return d->movingHorizontally || d->movingVertically;
+}
+
 /*!
-    \qmlproperty bool Flickable::moving
+    \qmlproperty bool Flickable::movingHorizontally
+    \qmlproperty bool Flickable::movingVertically
 
-    This property holds whether the view is currently moving due to
-    the user either dragging or flicking the view.
+    These properties hold whether the view is currently moving horizontally
+    or vertically due to the user either dragging or flicking the view.
 */
-bool QDeclarativeFlickable::isMoving() const
+bool QDeclarativeFlickable::isMovingHorizontally() const
+{
+    Q_D(const QDeclarativeFlickable);
+    return d->movingHorizontally;
+}
+
+bool QDeclarativeFlickable::isMovingVertically() const
 {
     Q_D(const QDeclarativeFlickable);
-    return d->moving;
+    return d->movingVertically;
 }
 
 void QDeclarativeFlickable::movementStarting()
 {
     Q_D(QDeclarativeFlickable);
-    if (!d->moving) {
-        d->moving = true;
-        emit movingChanged();
-        emit movementStarted();
+    if (d->hMoved && !d->movingHorizontally) {
+        d->movingHorizontally = true;
+        emit movingChanged(); // deprecated
+        emit movingHorizontallyChanged();
+    }
+    if (d->vMoved && !d->movingVertically) {
+        d->movingVertically = true;
+        emit movingChanged(); // deprecated
+        emit movingVerticallyChanged();
     }
 }
 
 void QDeclarativeFlickable::movementEnding()
 {
     Q_D(QDeclarativeFlickable);
-    if (d->moving) {
-        d->moving = false;
-        emit movingChanged();
-        emit movementEnded();
+    if (d->flickingHorizontally) {
+        d->flickingHorizontally = false;
+        emit flickingChanged(); // deprecated
+        emit flickingHorizontallyChanged();
+    }
+    if (d->flickingVertically) {
+        d->flickingVertically = false;
+        emit flickingChanged(); // deprecated
+        emit flickingVerticallyChanged();
+    }
+    if (d->movingHorizontally) {
+        d->movingHorizontally = false;
+        d->hMoved = false;
+        emit movingChanged(); // deprecated
+        emit movingHorizontallyChanged();
     }
-    if (d->flicked) {
-        d->flicked = false;
-        emit flickingChanged();
-        emit flickEnded();
+    if (d->movingVertically) {
+        d->movingVertically = false;
+        d->vMoved = false;
+        emit movingChanged(); // deprecated
+        emit movingVerticallyChanged();
     }
     d->hData.smoothVelocity.setValue(0);
     d->vData.smoothVelocity.setValue(0);