https://bugs.webkit.org/show_bug.cgi?id=71490
[WebKit-https.git] / Source / WebCore / platform / ScrollAnimator.h
1 /*
2  * Copyright (c) 2010, Google 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 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 ScrollAnimator_h
32 #define ScrollAnimator_h
33
34 #include "ScrollTypes.h"
35 #include <wtf/Forward.h>
36
37 namespace WebCore {
38
39 class FloatPoint;
40 class PlatformWheelEvent;
41 class ScrollableArea;
42 class Scrollbar;
43
44 #if ENABLE(GESTURE_EVENTS)
45 class PlatformGestureEvent;
46 #endif
47
48 class ScrollAnimator {
49 public:
50     enum ZoomAnimationState { ZoomAnimationContinuing, ZoomAnimationFinishing };
51
52     static PassOwnPtr<ScrollAnimator> create(ScrollableArea*);
53
54     virtual ~ScrollAnimator();
55
56     // Computes a scroll destination for the given parameters.  Returns false if
57     // already at the destination.  Otherwise, starts scrolling towards the
58     // destination and returns true.  Scrolling may be immediate or animated.
59     // The base class implementation always scrolls immediately, never animates.
60     virtual bool scroll(ScrollbarOrientation, ScrollGranularity, float step, float multiplier);
61
62     virtual void scrollToOffsetWithoutAnimation(const FloatPoint&);
63
64     ScrollableArea* scrollableArea() const { return m_scrollableArea; }
65
66     virtual void setIsActive() { }
67
68     virtual bool handleWheelEvent(const PlatformWheelEvent&);
69 #if ENABLE(GESTURE_EVENTS)
70     virtual void handleGestureEvent(const PlatformGestureEvent&);
71 #endif
72
73     FloatPoint currentPosition() const;
74
75     virtual void cancelAnimations() { }
76
77     virtual void contentAreaWillPaint() const { }
78     virtual void mouseEnteredContentArea() const { }
79     virtual void mouseExitedContentArea() const { }
80     virtual void mouseMovedInContentArea() const { }
81     virtual void mouseEnteredScrollbar(Scrollbar*) const { }
82     virtual void mouseExitedScrollbar(Scrollbar*) const { }
83     virtual void willStartLiveResize() { }
84     virtual void contentsResized() const { }
85     virtual void willEndLiveResize() { }
86     virtual void contentAreaDidShow() const { }
87     virtual void contentAreaDidHide() const { }
88
89     virtual void didAddVerticalScrollbar(Scrollbar*) { }
90     virtual void willRemoveVerticalScrollbar(Scrollbar*) { }
91     virtual void didAddHorizontalScrollbar(Scrollbar*) { }
92     virtual void willRemoveHorizontalScrollbar(Scrollbar*) { }
93
94     float zoomScale() const { return m_currentZoomScale; }
95     FloatPoint zoomTranslation() const;
96     virtual void resetZoom();
97     virtual void setZoomParametersForTest(float, float, float);
98
99 protected:
100     ScrollAnimator(ScrollableArea*);
101
102     virtual void notifyPositionChanged();
103     virtual void notifyZoomChanged(ZoomAnimationState);
104
105     ScrollableArea* m_scrollableArea;
106     float m_currentPosX; // We avoid using a FloatPoint in order to reduce
107     float m_currentPosY; // subclass code complexity.
108
109     float m_currentZoomScale;
110     float m_currentZoomTransX;
111     float m_currentZoomTransY;
112 };
113
114 } // namespace WebCore
115
116 #endif // ScrollAnimator_h