1/*
2 * Copyright (C) 2004, 2005, 2006, 2009 Apple Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef PlatformWheelEvent_h
27#define PlatformWheelEvent_h
28
29#include "IntPoint.h"
30#include "PlatformEvent.h"
31#if OS(WINDOWS)
32#include "WindowsExtras.h"
33#endif
34
35#if PLATFORM(GTK)
36typedef struct _GdkEventScroll GdkEventScroll;
37#endif
38
39#if PLATFORM(EFL)
40typedef struct _Evas_Event_Mouse_Wheel Evas_Event_Mouse_Wheel;
41#endif
42
43namespace WebCore {
44
45    class FloatPoint;
46    class FloatSize;
47
48    // Wheel events come in two flavors:
49    // The ScrollByPixelWheelEvent is a fine-grained event that specifies the precise number of pixels to scroll.  It is sent directly by MacBook touchpads on OS X,
50    // and synthesized in other cases where platforms generate line-by-line scrolling events.
51    // The ScrollByPageWheelEvent indicates that the wheel event should scroll an entire page.  In this case WebCore's built in paging behavior is used to page
52    // up and down (you get the same behavior as if the user was clicking in a scrollbar track to page up or page down).
53    enum PlatformWheelEventGranularity {
54        ScrollByPageWheelEvent,
55        ScrollByPixelWheelEvent,
56    };
57
58#if PLATFORM(MAC)
59    enum PlatformWheelEventPhase {
60        PlatformWheelEventPhaseNone        = 0,
61        PlatformWheelEventPhaseBegan       = 1 << 0,
62        PlatformWheelEventPhaseStationary  = 1 << 1,
63        PlatformWheelEventPhaseChanged     = 1 << 2,
64        PlatformWheelEventPhaseEnded       = 1 << 3,
65        PlatformWheelEventPhaseCancelled   = 1 << 4,
66        PlatformWheelEventPhaseMayBegin    = 1 << 5,
67    };
68#endif
69
70    class PlatformWheelEvent : public PlatformEvent {
71    public:
72        PlatformWheelEvent()
73            : PlatformEvent(PlatformEvent::Wheel)
74            , m_deltaX(0)
75            , m_deltaY(0)
76            , m_wheelTicksX(0)
77            , m_wheelTicksY(0)
78            , m_granularity(ScrollByPixelWheelEvent)
79            , m_directionInvertedFromDevice(false)
80#if PLATFORM(MAC)
81            , m_hasPreciseScrollingDeltas(false)
82            , m_phase(PlatformWheelEventPhaseNone)
83            , m_momentumPhase(PlatformWheelEventPhaseNone)
84            , m_scrollCount(0)
85            , m_unacceleratedScrollingDeltaX(0)
86            , m_unacceleratedScrollingDeltaY(0)
87#endif
88        {
89        }
90
91        PlatformWheelEvent(IntPoint position, IntPoint globalPosition, float deltaX, float deltaY, float wheelTicksX, float wheelTicksY, PlatformWheelEventGranularity granularity, bool shiftKey, bool ctrlKey, bool altKey, bool metaKey)
92            : PlatformEvent(PlatformEvent::Wheel, shiftKey, ctrlKey, altKey, metaKey, 0)
93            , m_position(position)
94            , m_globalPosition(globalPosition)
95            , m_deltaX(deltaX)
96            , m_deltaY(deltaY)
97            , m_wheelTicksX(wheelTicksX)
98            , m_wheelTicksY(wheelTicksY)
99            , m_granularity(granularity)
100            , m_directionInvertedFromDevice(false)
101#if PLATFORM(MAC)
102            , m_hasPreciseScrollingDeltas(false)
103            , m_phase(PlatformWheelEventPhaseNone)
104            , m_momentumPhase(PlatformWheelEventPhaseNone)
105            , m_scrollCount(0)
106            , m_unacceleratedScrollingDeltaX(0)
107            , m_unacceleratedScrollingDeltaY(0)
108#endif
109        {
110        }
111
112        PlatformWheelEvent copyTurningVerticalTicksIntoHorizontalTicks() const
113        {
114            PlatformWheelEvent copy = *this;
115
116            copy.m_deltaX = copy.m_deltaY;
117            copy.m_deltaY = 0;
118            copy.m_wheelTicksX = copy.m_wheelTicksY;
119            copy.m_wheelTicksY = 0;
120
121            return copy;
122        }
123
124        const IntPoint& position() const { return m_position; } // PlatformWindow coordinates.
125        const IntPoint& globalPosition() const { return m_globalPosition; } // Screen coordinates.
126
127        float deltaX() const { return m_deltaX; }
128        float deltaY() const { return m_deltaY; }
129
130        float wheelTicksX() const { return m_wheelTicksX; }
131        float wheelTicksY() const { return m_wheelTicksY; }
132
133        PlatformWheelEventGranularity granularity() const { return m_granularity; }
134
135        bool directionInvertedFromDevice() const { return m_directionInvertedFromDevice; }
136
137#if PLATFORM(GTK)
138        explicit PlatformWheelEvent(GdkEventScroll*);
139#endif
140
141#if PLATFORM(EFL)
142        explicit PlatformWheelEvent(const Evas_Event_Mouse_Wheel*);
143#endif
144
145#if PLATFORM(MAC)
146        bool hasPreciseScrollingDeltas() const { return m_hasPreciseScrollingDeltas; }
147        void setHasPreciseScrollingDeltas(bool b) { m_hasPreciseScrollingDeltas = b; }
148        PlatformWheelEventPhase phase() const { return m_phase; }
149        PlatformWheelEventPhase momentumPhase() const { return m_momentumPhase; }
150        unsigned scrollCount() const { return m_scrollCount; }
151        float unacceleratedScrollingDeltaX() const { return m_unacceleratedScrollingDeltaX; }
152        float unacceleratedScrollingDeltaY() const { return m_unacceleratedScrollingDeltaY; }
153        bool useLatchedEventNode() const { return m_momentumPhase == PlatformWheelEventPhaseBegan || m_momentumPhase == PlatformWheelEventPhaseChanged; }
154#else
155        bool useLatchedEventNode() const { return false; }
156#endif
157
158#if PLATFORM(WIN)
159        PlatformWheelEvent(HWND, WPARAM, LPARAM, bool isMouseHWheel);
160        PlatformWheelEvent(HWND, const FloatSize& delta, const FloatPoint& location);
161#endif
162
163    protected:
164        IntPoint m_position;
165        IntPoint m_globalPosition;
166        float m_deltaX;
167        float m_deltaY;
168        float m_wheelTicksX;
169        float m_wheelTicksY;
170        PlatformWheelEventGranularity m_granularity;
171        bool m_directionInvertedFromDevice;
172#if PLATFORM(MAC)
173        bool m_hasPreciseScrollingDeltas;
174        PlatformWheelEventPhase m_phase;
175        PlatformWheelEventPhase m_momentumPhase;
176        unsigned m_scrollCount;
177        float m_unacceleratedScrollingDeltaX;
178        float m_unacceleratedScrollingDeltaY;
179#endif
180    };
181
182} // namespace WebCore
183
184#endif // PlatformWheelEvent_h
185