Wheel events don't latch to inner scrollable elements
[WebKit-https.git] / Source / WebCore / page / WheelEventDeltaTracker.h
1 /*
2  * Copyright (C) 2014 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 INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26
27 #ifndef WheelEventDeltaTracker_h
28 #define WheelEventDeltaTracker_h
29
30 #include "FloatSize.h"
31 #include <wtf/Deque.h>
32
33 namespace WebCore {
34
35 class PlatformWheelEvent;
36
37 const size_t recentEventCount = 3;
38
39 enum class DominantScrollGestureDirection {
40     None,
41     Vertical,
42     Horizontal
43 };
44
45 class WheelEventDeltaTracker {
46 public:
47     WheelEventDeltaTracker();
48     virtual ~WheelEventDeltaTracker();
49
50     void beginTrackingDeltas();
51     void endTrackingDeltas();
52
53     bool isTrackingDeltas() const { return m_isTrackingDeltas; }
54     bool isFirstWheelEvent() const { return m_recentWheelEventDeltas.size() <= 1; }
55
56     void recordWheelEventDelta(const PlatformWheelEvent&);
57     DominantScrollGestureDirection dominantScrollGestureDirection() const;
58
59 private:
60     Deque<FloatSize, recentEventCount> m_recentWheelEventDeltas;
61     bool m_isTrackingDeltas;
62
63 };
64
65 } // namespace WebCore
66
67 #endif // WheelEventDeltaTracker_h