1/****************************************************************************
2**
3** Copyright (C) 2019 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 QQUICKWHEELHANDLER_H
41#define QQUICKWHEELHANDLER_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
58QT_BEGIN_NAMESPACE
59
60class QQuickWheelEvent;
61class QQuickWheelHandlerPrivate;
62
63class Q_QUICK_PRIVATE_EXPORT QQuickWheelHandler : public QQuickSinglePointHandler
64{
65 Q_OBJECT
66 Q_PROPERTY(Qt::Orientation orientation READ orientation WRITE setOrientation NOTIFY orientationChanged)
67 Q_PROPERTY(bool invertible READ isInvertible WRITE setInvertible NOTIFY invertibleChanged)
68 Q_PROPERTY(qreal activeTimeout READ activeTimeout WRITE setActiveTimeout NOTIFY activeTimeoutChanged)
69 Q_PROPERTY(qreal rotation READ rotation WRITE setRotation NOTIFY rotationChanged)
70 Q_PROPERTY(qreal rotationScale READ rotationScale WRITE setRotationScale NOTIFY rotationScaleChanged)
71 Q_PROPERTY(QString property READ property WRITE setProperty NOTIFY propertyChanged)
72 Q_PROPERTY(qreal targetScaleMultiplier READ targetScaleMultiplier WRITE setTargetScaleMultiplier NOTIFY targetScaleMultiplierChanged)
73 Q_PROPERTY(bool targetTransformAroundCursor READ isTargetTransformAroundCursor WRITE setTargetTransformAroundCursor NOTIFY targetTransformAroundCursorChanged)
74
75public:
76 explicit QQuickWheelHandler(QQuickItem *parent = nullptr);
77
78 Qt::Orientation orientation() const;
79 void setOrientation(Qt::Orientation orientation);
80
81 bool isInvertible() const;
82 void setInvertible(bool invertible);
83
84 qreal activeTimeout() const;
85 void setActiveTimeout(qreal timeout);
86
87 qreal rotation() const;
88 void setRotation(qreal rotation);
89
90 qreal rotationScale() const;
91 void setRotationScale(qreal rotationScale);
92
93 QString property() const;
94 void setProperty(const QString &name);
95
96 qreal targetScaleMultiplier() const;
97 void setTargetScaleMultiplier(qreal targetScaleMultiplier);
98
99 bool isTargetTransformAroundCursor() const;
100 void setTargetTransformAroundCursor(bool ttac);
101
102Q_SIGNALS:
103 void wheel(QQuickPointerScrollEvent *event);
104
105 void orientationChanged();
106 void invertibleChanged();
107 void activeTimeoutChanged();
108 void rotationChanged();
109 void rotationScaleChanged();
110 void propertyChanged();
111 void targetScaleMultiplierChanged();
112 void targetTransformAroundCursorChanged();
113
114protected:
115 bool wantsPointerEvent(QQuickPointerEvent *event) override;
116 void handleEventPoint(QQuickEventPoint *point) override;
117 void onTargetChanged(QQuickItem *oldTarget) override;
118 void onActiveChanged() override;
119 void timerEvent(QTimerEvent *event) override;
120
121 Q_DECLARE_PRIVATE(QQuickWheelHandler)
122};
123
124QT_END_NAMESPACE
125
126QML_DECLARE_TYPE(QQuickWheelHandler)
127
128#endif // QQUICKWHEELHANDLER_H
129