summaryrefslogtreecommitdiffstats
path: root/scroller/qkineticscroller.h
blob: f7eef8fa5ce50ecbaf7c172b5497f95d5def69a9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QKINETICSCROLLER_H
#define QKINETICSCROLLER_H

#include <QtCore/qmetatype.h>
#include <QtCore/qpoint.h>
#include <QtCore/qrect.h>
#include <QtCore/qvariant.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Gui)

class QKineticScrollerPrivate;

class QKineticScroller
{
public:
    virtual ~QKineticScroller();

    bool isEnabled() const;
    void setEnabled(bool b);

    enum State
    {
        StateInactive,
        StatePressed,
        StateDragging,
        StateScrolling,
    };

    State state() const;
    void reset();

    enum OvershootPolicy
    {
        OvershootWhenScrollable,
        OvershootAlwaysOff,
        OvershootAlwaysOn,
    };

    OvershootPolicy horizontalOvershootPolicy() const;
    void setHorizontalOvershootPolicy(OvershootPolicy policy);
    OvershootPolicy verticalOvershootPolicy() const;
    void setVerticalOvershootPolicy(OvershootPolicy policy);

    enum ScrollMetric
    {
        DragVelocitySmoothingFactor,             // qreal [0..1/s]  (complex calculation involving time) v = v_new* DASF + v_old * (1-DASF)

        LinearDecelerationFactor,                // qreal [m/s^2]
        ExponentialDecelerationBase,             // qreal
        OvershootSpringConstant,                 // qreal [kg/s^2]
        OvershootDragResistanceFactor,           // qreal [0..1]
        OvershootMaximumDistance,                // QPointF([m], [m])

        DragStartDistance,                       // qreal [m]
        DragStartDirectionErrorMargin,           // qreal [m]

        MinimumVelocity,                         // qreal [m/s]
        MaximumVelocity,                         // qreal [m/s]
        MaximumNonAcceleratedVelocity,           // qreal [m/s]

        MaximumClickThroughVelocity,             // qreal [m/s]
        AxisLockThreshold,                       // qreal [0..1] atan(|min(dx,dy)|/|max(dx,dy)|)

        FramesPerSecond,                         // int [frames/s]

        FastSwipeMaximumTime,                    // qreal [s]
        FastSwipeMinimumVelocity,                // qreal [m/s]
        FastSwipeBaseVelocity,                   // qreal [m/s]

        ScrollMetricCount
    };

    QVariant scrollMetric(ScrollMetric metric) const;
    void setScrollMetric(ScrollMetric metric, const QVariant &value);
    void resetScrollMetrics();

    void scrollTo(const QPointF &pos, int scrollTime = 1000);
    void ensureVisible(const QPointF &pos, int xmargin, int ymargin, int scrollTime = 1000);

    qreal dpi() const;
    void setDpi(qreal dpi);
    void setDpiFromWidget(QWidget *widget);

    void registerDebugHook(void (*callback)(void *user, const QPointF &releaseVelocity, const QPointF &position, const QPointF &overshootPosition), void *user);

protected:
    explicit QKineticScroller();

    virtual QSizeF viewportSize() const = 0;
    virtual QPointF maximumContentPosition() const = 0;
    virtual QPointF contentPosition() const = 0;
    virtual void setContentPosition(const QPointF &pos, const QPointF &overshootDelta) = 0;

    virtual void stateChanged(State oldState);
    virtual bool canStartScrollingAt(const QPointF &pos) const;
    virtual void cancelPress(const QPointF &pressPos);

    enum Input {
        InputPress,
        InputMove,
        InputRelease
    };

    bool handleInput(Input input, const QPointF &position, qint64 timestamp);

    QKineticScroller(QKineticScrollerPrivate &dd);
    QScopedPointer<QKineticScrollerPrivate> d_ptr;

private:
    Q_DISABLE_COPY(QKineticScroller)
    Q_DECLARE_PRIVATE(QKineticScroller)
};

QT_END_NAMESPACE

Q_DECLARE_METATYPE(QKineticScroller *)

QT_END_HEADER

#endif // QKINETICSCROLLER_H