1/****************************************************************************
2**
3** Copyright (C) 2017 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtQuick 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 QQUICKTAPHANDLER_H
41#define QQUICKTAPHANDLER_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include "qquickitem.h"
55#include "qevent.h"
56#include "qquicksinglepointhandler_p.h"
57#include <QtCore/qbasictimer.h>
58
59QT_BEGIN_NAMESPACE
60
61class Q_QUICK_PRIVATE_EXPORT QQuickTapHandler : public QQuickSinglePointHandler
62{
63 Q_OBJECT
64 Q_PROPERTY(bool pressed READ isPressed NOTIFY pressedChanged)
65 Q_PROPERTY(int tapCount READ tapCount NOTIFY tapCountChanged)
66 Q_PROPERTY(qreal timeHeld READ timeHeld NOTIFY timeHeldChanged)
67 Q_PROPERTY(qreal longPressThreshold READ longPressThreshold WRITE setLongPressThreshold NOTIFY longPressThresholdChanged)
68 Q_PROPERTY(GesturePolicy gesturePolicy READ gesturePolicy WRITE setGesturePolicy NOTIFY gesturePolicyChanged)
69
70public:
71 enum GesturePolicy {
72 DragThreshold,
73 WithinBounds,
74 ReleaseWithinBounds
75 };
76 Q_ENUM(GesturePolicy)
77
78 explicit QQuickTapHandler(QQuickItem *parent = nullptr);
79
80 bool isPressed() const { return m_pressed; }
81
82 int tapCount() const { return m_tapCount; }
83 qreal timeHeld() const { return (m_holdTimer.isValid() ? m_holdTimer.elapsed() / 1000.0 : -1.0); }
84
85 qreal longPressThreshold() const;
86 void setLongPressThreshold(qreal longPressThreshold);
87
88 GesturePolicy gesturePolicy() const { return m_gesturePolicy; }
89 void setGesturePolicy(GesturePolicy gesturePolicy);
90
91Q_SIGNALS:
92 void pressedChanged();
93 void tapCountChanged();
94 void timeHeldChanged();
95 void longPressThresholdChanged();
96 void gesturePolicyChanged();
97 void tapped(QQuickEventPoint *eventPoint);
98 void singleTapped(QQuickEventPoint *eventPoint);
99 void doubleTapped(QQuickEventPoint *eventPoint);
100 void longPressed();
101
102protected:
103 void onGrabChanged(QQuickPointerHandler *grabber, QQuickEventPoint::GrabTransition transition, QQuickEventPoint *point) override;
104 void timerEvent(QTimerEvent *event) override;
105 bool wantsEventPoint(QQuickEventPoint *point) override;
106 void handleEventPoint(QQuickEventPoint *point) override;
107
108private:
109 void setPressed(bool press, bool cancel, QQuickEventPoint *point);
110 int longPressThresholdMilliseconds() const;
111 void connectPreRenderSignal(bool conn = true);
112 void updateTimeHeld();
113
114private:
115 QPointF m_lastTapPos;
116 qreal m_lastTapTimestamp = 0;
117 QElapsedTimer m_holdTimer;
118 QBasicTimer m_longPressTimer;
119 int m_tapCount = 0;
120 int m_longPressThreshold = -1;
121 GesturePolicy m_gesturePolicy = GesturePolicy::DragThreshold;
122 bool m_pressed = false;
123
124 static qreal m_multiTapInterval;
125 static int m_mouseMultiClickDistanceSquared;
126 static int m_touchMultiTapDistanceSquared;
127};
128
129QT_END_NAMESPACE
130
131QML_DECLARE_TYPE(QQuickTapHandler)
132
133#endif // QQUICKTAPHANDLER_H
134