Run clang-modernize and let it add a bunch of missing overrides.
[WebKit.git] / Source / WebCore / dom / WheelEvent.h
1 /*
2  * Copyright (C) 2001 Peter Kelly (pmk@post.com)
3  * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
4  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
5  * Copyright (C) 2003, 2004, 2005, 2006, 2008, 2010, 2013 Apple Inc. All rights reserved.
6  * Copyright (C) 2013 Samsung Electronics. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #ifndef WheelEvent_h
26 #define WheelEvent_h
27
28 #include "FloatPoint.h"
29 #include "MouseEvent.h"
30
31 namespace WebCore {
32
33 class PlatformWheelEvent;
34
35 struct WheelEventInit : public MouseEventInit {
36     WheelEventInit();
37
38     double deltaX;
39     double deltaY;
40     double deltaZ;
41     unsigned deltaMode;
42     int wheelDeltaX; // Deprecated.
43     int wheelDeltaY; // Deprecated.
44 };
45
46 class WheelEvent : public MouseEvent {
47 public:
48     enum { TickMultiplier = 120 };
49
50     enum DeltaMode {
51         DOM_DELTA_PIXEL = 0,
52         DOM_DELTA_LINE,
53         DOM_DELTA_PAGE
54     };
55
56     static PassRefPtr<WheelEvent> create()
57     {
58         return adoptRef(new WheelEvent);
59     }
60
61     static PassRefPtr<WheelEvent> create(const AtomicString& type, const WheelEventInit& initializer)
62     {
63         return adoptRef(new WheelEvent(type, initializer));
64     }
65
66     static PassRefPtr<WheelEvent> create(const FloatPoint& wheelTicks,
67         const FloatPoint& rawDelta, unsigned deltaMode, PassRefPtr<AbstractView> view,
68         const IntPoint& screenLocation, const IntPoint& pageLocation,
69         bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, bool directionInvertedFromDevice, double timestamp)
70     {
71         return adoptRef(new WheelEvent(wheelTicks, rawDelta, deltaMode, view,
72         screenLocation, pageLocation, ctrlKey, altKey, shiftKey, metaKey, directionInvertedFromDevice, timestamp));
73     }
74
75     void initWheelEvent(int rawDeltaX, int rawDeltaY, PassRefPtr<AbstractView>,
76         int screenX, int screenY, int pageX, int pageY,
77         bool ctrlKey, bool altKey, bool shiftKey, bool metaKey);
78
79     void initWebKitWheelEvent(int rawDeltaX, int rawDeltaY, PassRefPtr<AbstractView>,
80         int screenX, int screenY, int pageX, int pageY,
81         bool ctrlKey, bool altKey, bool shiftKey, bool metaKey);
82
83     double deltaX() const { return m_deltaX; } // Positive when scrolling right.
84     double deltaY() const { return m_deltaY; } // Positive when scrolling down.
85     double deltaZ() const { return m_deltaZ; }
86     int wheelDelta() const { return wheelDeltaY() ? wheelDeltaY() : wheelDeltaX(); } // Deprecated.
87     int wheelDeltaX() const { return m_wheelDelta.x(); } // Deprecated, negative when scrolling right.
88     int wheelDeltaY() const { return m_wheelDelta.y(); } // Deprecated, negative when scrolling down.
89     unsigned deltaMode() const { return m_deltaMode; }
90
91     bool webkitDirectionInvertedFromDevice() const { return m_directionInvertedFromDevice; }
92     // Needed for Objective-C legacy support
93     bool isHorizontal() const { return m_wheelDelta.x(); }
94
95     virtual EventInterface eventInterface() const override;
96     virtual bool isMouseEvent() const override;
97
98 private:
99     WheelEvent();
100     WheelEvent(const AtomicString&, const WheelEventInit&);
101     WheelEvent(const FloatPoint& wheelTicks, const FloatPoint& rawDelta,
102         unsigned, PassRefPtr<AbstractView>, const IntPoint& screenLocation, const IntPoint& pageLocation,
103         bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, bool directionInvertedFromDevice, double timestamp);
104
105     IntPoint m_wheelDelta;
106     double m_deltaX;
107     double m_deltaY;
108     double m_deltaZ;
109     unsigned m_deltaMode;
110     bool m_directionInvertedFromDevice;
111 };
112
113 } // namespace WebCore
114
115 #endif // WheelEvent_h