Make it possible to test rubber-banding in overflow scroll
[WebKit-https.git] / Source / WebCore / platform / gtk / ScrollAnimatorGtk.h
1 /*
2  * Copyright (c) 2016 Igalia S.L.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef ScrollAnimatorGtk_h
32 #define ScrollAnimatorGtk_h
33
34 #include "ScrollAnimator.h"
35 #include "Timer.h"
36
37 namespace WebCore {
38
39 class ScrollAnimation;
40
41 class ScrollAnimatorGtk final : public ScrollAnimator {
42 public:
43     explicit ScrollAnimatorGtk(ScrollableArea&);
44     virtual ~ScrollAnimatorGtk();
45
46 private:
47 #if ENABLE(SMOOTH_SCROLLING)
48     bool scroll(ScrollbarOrientation, ScrollGranularity, float step, float multiplier) override;
49 #endif
50     void scrollToOffsetWithoutAnimation(const FloatPoint&, ScrollClamping) override;
51     void willEndLiveResize() override;
52
53     bool handleWheelEvent(const PlatformWheelEvent&) override;
54
55     void didAddVerticalScrollbar(Scrollbar*) override;
56     void didAddHorizontalScrollbar(Scrollbar*) override;
57     void willRemoveVerticalScrollbar(Scrollbar*) override;
58     void willRemoveHorizontalScrollbar(Scrollbar*) override;
59
60     void mouseEnteredContentArea() override;
61     void mouseExitedContentArea() override;
62     void mouseMovedInContentArea() override;
63     void contentAreaDidShow() override;
64     void contentAreaDidHide() override;
65     void notifyContentAreaScrolled(const FloatSize& delta) override;
66     void lockOverlayScrollbarStateToHidden(bool) override;
67
68     void updatePosition(FloatPoint&&);
69
70     void overlayScrollbarAnimationTimerFired();
71     void showOverlayScrollbars();
72     void hideOverlayScrollbars();
73     void updateOverlayScrollbarsOpacity();
74
75     FloatPoint computeVelocity();
76
77 #if ENABLE(SMOOTH_SCROLLING)
78     void ensureSmoothScrollingAnimation();
79
80     std::unique_ptr<ScrollAnimation> m_smoothAnimation;
81 #endif
82     std::unique_ptr<ScrollAnimation> m_kineticAnimation;
83     Vector<PlatformWheelEvent> m_scrollHistory;
84     Scrollbar* m_horizontalOverlayScrollbar { nullptr };
85     Scrollbar* m_verticalOverlayScrollbar { nullptr };
86     bool m_overlayScrollbarsLocked { false };
87     Timer m_overlayScrollbarAnimationTimer;
88     double m_overlayScrollbarAnimationSource { 0 };
89     double m_overlayScrollbarAnimationTarget { 0 };
90     double m_overlayScrollbarAnimationCurrent { 0 };
91     MonotonicTime m_overlayScrollbarAnimationStartTime;
92     MonotonicTime m_overlayScrollbarAnimationEndTime;
93 };
94
95 } // namespace WebCore
96
97 #endif // ScrollAnimatorGtk_h