Move all rubber-banding related member variables to ScrollElasticityController
[WebKit-https.git] / Source / WebCore / platform / mac / ScrollAnimatorMac.h
1 /*
2  * Copyright (C) 2010, 2011 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 #ifndef ScrollAnimatorMac_h
27 #define ScrollAnimatorMac_h
28
29 #if ENABLE(SMOOTH_SCROLLING)
30
31 #include "IntRect.h"
32 #include "FloatPoint.h"
33 #include "FloatSize.h"
34 #include "ScrollAnimator.h"
35 #include "ScrollElasticityController.h"
36 #include "Timer.h"
37 #include <wtf/RetainPtr.h>
38
39 #ifdef __OBJC__
40 @class WebScrollAnimationHelperDelegate;
41 @class WebScrollbarPainterControllerDelegate;
42 @class WebScrollbarPainterDelegate;
43 #else
44 class WebScrollAnimationHelperDelegate;
45 class WebScrollbarPainterControllerDelegate;
46 class WebScrollbarPainterDelegate;
47 #endif
48
49 #if USE(SCROLLBAR_PAINTER)
50 typedef id ScrollbarPainterController;
51 #endif
52
53 #if !ENABLE(RUBBER_BANDING)
54 class ScrollElasticityControllerClient { };
55 #endif
56
57 namespace WebCore {
58
59 class Scrollbar;
60
61 class ScrollAnimatorMac : public ScrollAnimator, private ScrollElasticityControllerClient {
62
63 public:
64     ScrollAnimatorMac(ScrollableArea*);
65     virtual ~ScrollAnimatorMac();
66
67     virtual bool scroll(ScrollbarOrientation, ScrollGranularity, float step, float multiplier);
68     virtual void scrollToOffsetWithoutAnimation(const FloatPoint&);
69
70 #if ENABLE(RUBBER_BANDING)
71     virtual bool handleWheelEvent(const PlatformWheelEvent&) OVERRIDE;
72 #if ENABLE(GESTURE_EVENTS)
73     virtual void handleGestureEvent(const PlatformGestureEvent&);
74 #endif
75 #endif
76
77     virtual void cancelAnimations();
78
79     void immediateScrollToPoint(const FloatPoint& newPosition);
80     void immediateScrollByDeltaX(float deltaX);
81     void immediateScrollByDeltaY(float deltaY);
82
83     void immediateScrollToPointForScrollAnimation(const FloatPoint& newPosition);
84
85     void setIsDrawingIntoLayer(bool b) { m_drawingIntoLayer = b; }
86     bool isDrawingIntoLayer() const { return m_drawingIntoLayer; }
87
88     bool haveScrolledSincePageLoad() const { return m_haveScrolledSincePageLoad; }
89
90     virtual void setIsActive();
91
92 #if USE(SCROLLBAR_PAINTER)
93     void updateScrollerStyle();
94
95     bool scrollbarPaintTimerIsActive() const;
96     void startScrollbarPaintTimer();
97     void stopScrollbarPaintTimer();
98 #endif
99
100     void setVisibleScrollerThumbRect(const IntRect&);
101
102 private:
103     RetainPtr<id> m_scrollAnimationHelper;
104     RetainPtr<WebScrollAnimationHelperDelegate> m_scrollAnimationHelperDelegate;
105
106 #if USE(SCROLLBAR_PAINTER)
107     RetainPtr<ScrollbarPainterController> m_scrollbarPainterController;
108     RetainPtr<WebScrollbarPainterControllerDelegate> m_scrollbarPainterControllerDelegate;
109     RetainPtr<WebScrollbarPainterDelegate> m_scrollbarPainterDelegate;
110
111     void initialScrollbarPaintTimerFired(Timer<ScrollAnimatorMac>*);
112     Timer<ScrollAnimatorMac> m_initialScrollbarPaintTimer;
113 #endif
114     
115     virtual void notifyPositionChanged();
116     virtual void contentAreaWillPaint() const;
117     virtual void mouseEnteredContentArea() const;
118     virtual void mouseExitedContentArea() const;
119     virtual void mouseMovedInContentArea() const;
120     virtual void willStartLiveResize();
121     virtual void contentsResized() const;
122     virtual void willEndLiveResize();
123     virtual void contentAreaDidShow() const;
124     virtual void contentAreaDidHide() const;
125     void didBeginScrollGesture() const;
126     void didEndScrollGesture() const;
127
128     virtual void didAddVerticalScrollbar(Scrollbar*);
129     virtual void willRemoveVerticalScrollbar(Scrollbar*);
130     virtual void didAddHorizontalScrollbar(Scrollbar*);
131     virtual void willRemoveHorizontalScrollbar(Scrollbar*);
132
133     void setNeedsScrollerStyleUpdate(bool needsUpdate) { m_needsScrollerStyleUpdate = needsUpdate; }
134     bool needsScrollerStyleUpdate() const { return m_needsScrollerStyleUpdate; }
135
136     float adjustScrollXPositionIfNecessary(float) const;
137     float adjustScrollYPositionIfNecessary(float) const;
138     FloatPoint adjustScrollPositionIfNecessary(const FloatPoint&) const;
139
140 #if ENABLE(RUBBER_BANDING)
141     bool allowsVerticalStretching() const;
142     bool allowsHorizontalStretching() const;
143     bool pinnedInDirection(float deltaX, float deltaY);
144     void snapRubberBand();
145     void snapRubberBandTimerFired(Timer<ScrollAnimatorMac>*);
146     void smoothScrollWithEvent(const PlatformWheelEvent&);
147     void beginScrollGesture();
148     void endScrollGesture();
149
150     ScrollElasticityController m_scrollElasticityController;
151     Timer<ScrollAnimatorMac> m_snapRubberBandTimer;
152 #endif
153
154     bool m_drawingIntoLayer;
155     bool m_haveScrolledSincePageLoad;
156     bool m_needsScrollerStyleUpdate;
157     IntRect m_visibleScrollerThumbRect;
158 };
159
160 } // namespace WebCore
161
162 #endif // ENABLE(SMOOTH_SCROLLING)
163
164 #endif // ScrollAnimatorMac_h