1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtWidgets module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QSCROLLERPROPERTIES_H
41#define QSCROLLERPROPERTIES_H
42
43#include <QtWidgets/qtwidgetsglobal.h>
44#include <QtCore/QScopedPointer>
45#include <QtCore/QMetaType>
46#include <QtCore/QVariant>
47
48QT_REQUIRE_CONFIG(scroller);
49
50QT_BEGIN_NAMESPACE
51
52
53class QScroller;
54class QScrollerPrivate;
55class QScrollerPropertiesPrivate;
56
57class Q_WIDGETS_EXPORT QScrollerProperties
58{
59public:
60 QScrollerProperties();
61 QScrollerProperties(const QScrollerProperties &sp);
62 QScrollerProperties &operator=(const QScrollerProperties &sp);
63 virtual ~QScrollerProperties();
64
65 bool operator==(const QScrollerProperties &sp) const;
66 bool operator!=(const QScrollerProperties &sp) const;
67
68 static void setDefaultScrollerProperties(const QScrollerProperties &sp);
69 static void unsetDefaultScrollerProperties();
70
71 enum OvershootPolicy
72 {
73 OvershootWhenScrollable,
74 OvershootAlwaysOff,
75 OvershootAlwaysOn
76 };
77
78 enum FrameRates {
79 Standard,
80 Fps60,
81 Fps30,
82 Fps20
83 };
84
85 enum ScrollMetric
86 {
87 MousePressEventDelay, // qreal [s]
88 DragStartDistance, // qreal [m]
89 DragVelocitySmoothingFactor, // qreal [0..1/s] (complex calculation involving time) v = v_new* DASF + v_old * (1-DASF)
90 AxisLockThreshold, // qreal [0..1] atan(|min(dx,dy)|/|max(dx,dy)|)
91
92 ScrollingCurve, // QEasingCurve
93 DecelerationFactor, // slope of the curve
94
95 MinimumVelocity, // qreal [m/s]
96 MaximumVelocity, // qreal [m/s]
97 MaximumClickThroughVelocity, // qreal [m/s]
98
99 AcceleratingFlickMaximumTime, // qreal [s]
100 AcceleratingFlickSpeedupFactor, // qreal [1..]
101
102 SnapPositionRatio, // qreal [0..1]
103 SnapTime, // qreal [s]
104
105 OvershootDragResistanceFactor, // qreal [0..1]
106 OvershootDragDistanceFactor, // qreal [0..1]
107 OvershootScrollDistanceFactor, // qreal [0..1]
108 OvershootScrollTime, // qreal [s]
109
110 HorizontalOvershootPolicy, // enum OvershootPolicy
111 VerticalOvershootPolicy, // enum OvershootPolicy
112 FrameRate, // enum FrameRates
113
114 ScrollMetricCount
115 };
116
117 QVariant scrollMetric(ScrollMetric metric) const;
118 void setScrollMetric(ScrollMetric metric, const QVariant &value);
119
120protected:
121 QScopedPointer<QScrollerPropertiesPrivate> d;
122
123private:
124 QScrollerProperties(QScrollerPropertiesPrivate &dd);
125
126 friend class QScrollerPropertiesPrivate;
127 friend class QScroller;
128 friend class QScrollerPrivate;
129};
130
131QT_END_NAMESPACE
132
133Q_DECLARE_METATYPE(QScrollerProperties::OvershootPolicy)
134Q_DECLARE_METATYPE(QScrollerProperties::FrameRates)
135
136#endif // QSCROLLERPROPERTIES_H
137