src/quick/items/qquickflickable_p_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQUICKFLICKABLE_P_P_H
  43 #define QQUICKFLICKABLE_P_P_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists purely as an
  50 // implementation detail.  This header file may change from version to
  51 // version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include "qquickflickable_p.h"
  57 #include "qquickitem_p.h"
  58 #include "qquickitemchangelistener_p.h"
  59
  60 #include <QtQml/qqml.h>
  61 #include <QtCore/qdatetime.h>
  62 #include "qplatformdefs.h"
  63
  64 #include <private/qquicktimeline_p_p.h>
  65 #include <private/qquickanimation_p_p.h>
  66
  67 QT_BEGIN_NAMESPACE
  68
  69 // Really slow flicks can be annoying.
  70 const qreal MinimumFlickVelocity = 75.0;
  71
  72 class QQuickFlickableVisibleArea;
  73 class Q_AUTOTEST_EXPORT QQuickFlickablePrivate : public QQuickItemPrivate, public QQuickItemChangeListener
  74 {
  75     Q_DECLARE_PUBLIC(QQuickFlickable)
  76
  77 public:
  78     static inline QQuickFlickablePrivate *get(QQuickFlickable *o) { return o->d_func(); }
  79
  80     QQuickFlickablePrivate();
  81     void init();
  82
  83     struct Velocity : public QQuickTimeLineValue
  84     {
  85         Velocity(QQuickFlickablePrivate *p)
  86             : parent(p) {}
  87         virtual void setValue(qreal v) {
  88             if (v != value()) {
  89                 QQuickTimeLineValue::setValue(v);
  90                 parent->updateVelocity();
  91             }
  92         }
  93         QQuickFlickablePrivate *parent;
  94     };
  95
  96     struct AxisData {
  97         AxisData(QQuickFlickablePrivate *fp, void (QQuickFlickablePrivate::*func)(qreal))
  98             : move(fp, func), viewSize(-1), startMargin(0), endMargin(0)
  99             , continuousFlickVelocity(0)
 100             , smoothVelocity(fp), atEnd(false), atBeginning(true)
 101             , fixingUp(false), inOvershoot(false), moving(false), flicking(false)
 102             , dragging(false), extentsChanged(false)
 103             , explicitValue(false), minExtentDirty(true), maxExtentDirty(true)
 104         {}
 105
 106         void reset() {
 107             velocityBuffer.clear();
 108             dragStartOffset = 0;
 109             fixingUp = false;
 110             inOvershoot = false;
 111         }
 112
 113         void markExtentsDirty() {
 114             minExtentDirty = true;
 115             maxExtentDirty = true;
 116             extentsChanged = true;
 117         }
 118
 119         void addVelocitySample(qreal v, qreal maxVelocity);
 120         void updateVelocity();
 121
 122         QQuickTimeLineValueProxy<QQuickFlickablePrivate> move;
 123         qreal viewSize;
 124         qreal pressPos;
 125         qreal dragStartOffset;
 126         qreal dragMinBound;
 127         qreal dragMaxBound;
 128         qreal velocity;
 129         qreal flickTarget;
 130         qreal startMargin;
 131         qreal endMargin;
 132         qreal continuousFlickVelocity;
 133         QQuickFlickablePrivate::Velocity smoothVelocity;
 134         QPODVector<qreal,10> velocityBuffer;
 135         bool atEnd : 1;
 136         bool atBeginning : 1;
 137         bool fixingUp : 1;
 138         bool inOvershoot : 1;
 139         bool moving : 1;
 140         bool flicking : 1;
 141         bool dragging : 1;
 142         bool extentsChanged : 1;
 143         bool explicitValue : 1;
 144         mutable bool minExtentDirty : 1;
 145         mutable bool maxExtentDirty : 1;
 146     };
 147
 148     bool flickX(qreal velocity);
 149     bool flickY(qreal velocity);
 150     virtual bool flick(AxisData &data, qreal minExtent, qreal maxExtent, qreal vSize,
 151                         QQuickTimeLineCallback::Callback fixupCallback, qreal velocity);
 152     void flickingStarted(bool flickingH, bool flickingV);
 153
 154     void fixupX();
 155     void fixupY();
 156     virtual void fixup(AxisData &data, qreal minExtent, qreal maxExtent);
 157
 158     void updateBeginningEnd();
 159
 160     bool isOutermostPressDelay() const;
 161     void captureDelayedPress(QMouseEvent *event);
 162     void clearDelayedPress();
 163
 164     void setViewportX(qreal x);
 165     void setViewportY(qreal y);
 166
 167     qreal overShootDistance(qreal size);
 168
 169     void itemGeometryChanged(QQuickItem *, const QRectF &, const QRectF &);
 170
 171     void draggingStarting();
 172     void draggingEnding();
 173
 174 public:
 175     QQuickItem *contentItem;
 176
 177     AxisData hData;
 178     AxisData vData;
 179
 180     QQuickTimeLine timeline;
 181     bool hMoved : 1;
 182     bool vMoved : 1;
 183     bool stealMouse : 1;
 184     bool pressed : 1;
 185     bool interactive : 1;
 186     bool calcVelocity : 1;
 187     bool pixelAligned : 1;
 188     QElapsedTimer timer;
 189     qint64 lastPosTime;
 190     qint64 lastPressTime;
 191     QPointF lastPos;
 192     QPointF pressPos;
 193     qreal deceleration;
 194     qreal maxVelocity;
 195     QElapsedTimer velocityTime;
 196     QPointF lastFlickablePosition;
 197     qreal reportedVelocitySmoothing;
 198     QMouseEvent *delayedPressEvent;
 199     QQuickItem *delayedPressTarget;
 200     QBasicTimer delayedPressTimer;
 201     int pressDelay;
 202     int fixupDuration;
 203     qreal flickBoost;
 204
 205     enum FixupMode { Normal, Immediate, ExtentChanged };
 206     FixupMode fixupMode;
 207
 208     static void fixupY_callback(void *);
 209     static void fixupX_callback(void *);
 210
 211     void updateVelocity();
 212     int vTime;
 213     QQuickTimeLine velocityTimeline;
 214     QQuickFlickableVisibleArea *visibleArea;
 215     QQuickFlickable::FlickableDirection flickableDirection;
 216     QQuickFlickable::BoundsBehavior boundsBehavior;
 217
 218     void handleMousePressEvent(QMouseEvent *);
 219     void handleMouseMoveEvent(QMouseEvent *);
 220     void handleMouseReleaseEvent(QMouseEvent *);
 221
 222     qint64 computeCurrentTime(QInputEvent *event);
 223
 224     // flickableData property
 225     static void data_append(QQmlListProperty<QObject> *, QObject *);
 226     static int data_count(QQmlListProperty<QObject> *);
 227     static QObject *data_at(QQmlListProperty<QObject> *, int);
 228     static void data_clear(QQmlListProperty<QObject> *);
 229 };
 230
 231 class QQuickFlickableVisibleArea : public QObject
 232 {
 233     Q_OBJECT
 234
 235     Q_PROPERTY(qreal xPosition READ xPosition NOTIFY xPositionChanged)
 236     Q_PROPERTY(qreal yPosition READ yPosition NOTIFY yPositionChanged)
 237     Q_PROPERTY(qreal widthRatio READ widthRatio NOTIFY widthRatioChanged)
 238     Q_PROPERTY(qreal heightRatio READ heightRatio NOTIFY heightRatioChanged)
 239
 240 public:
 241     QQuickFlickableVisibleArea(QQuickFlickable *parent=0);
 242
 243     qreal xPosition() const;
 244     qreal widthRatio() const;
 245     qreal yPosition() const;
 246     qreal heightRatio() const;
 247
 248     void updateVisible();
 249
 250 signals:
 251     void xPositionChanged(qreal xPosition);
 252     void yPositionChanged(qreal yPosition);
 253     void widthRatioChanged(qreal widthRatio);
 254     void heightRatioChanged(qreal heightRatio);
 255
 256 private:
 257     QQuickFlickable *flickable;
 258     qreal m_xPosition;
 259     qreal m_widthRatio;
 260     qreal m_yPosition;
 261     qreal m_heightRatio;
 262 };
 263
 264 QT_END_NAMESPACE
 265
 266 QML_DECLARE_TYPE(QQuickFlickableVisibleArea)
 267
 268 #endif // QQUICKFLICKABLE_P_P_H