More ScrollAnimatorMac cleanup
[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 typedef id ScrollbarPainterController;
50
51 #if !ENABLE(RUBBER_BANDING)
52 class ScrollElasticityControllerClient { };
53 #endif
54
55 namespace WebCore {
56
57 class Scrollbar;
58
59 class ScrollAnimatorMac : public ScrollAnimator, private ScrollElasticityControllerClient {
60
61 public:
62     ScrollAnimatorMac(ScrollableArea*);
63     virtual ~ScrollAnimatorMac();
64
65     void immediateScrollToPointForScrollAnimation(const FloatPoint& newPosition);
66     bool haveScrolledSincePageLoad() const { return m_haveScrolledSincePageLoad; }
67
68     void updateScrollerStyle();
69
70     bool scrollbarPaintTimerIsActive() const;
71     void startScrollbarPaintTimer();
72     void stopScrollbarPaintTimer();
73
74     void setVisibleScrollerThumbRect(const IntRect&);
75
76 private:
77     RetainPtr<id> m_scrollAnimationHelper;
78     RetainPtr<WebScrollAnimationHelperDelegate> m_scrollAnimationHelperDelegate;
79
80     RetainPtr<ScrollbarPainterController> m_scrollbarPainterController;
81     RetainPtr<WebScrollbarPainterControllerDelegate> m_scrollbarPainterControllerDelegate;
82     RetainPtr<WebScrollbarPainterDelegate> m_horizontalScrollbarPainterDelegate;
83     RetainPtr<WebScrollbarPainterDelegate> m_verticalScrollbarPainterDelegate;
84
85     void initialScrollbarPaintTimerFired(Timer<ScrollAnimatorMac>*);
86     Timer<ScrollAnimatorMac> m_initialScrollbarPaintTimer;
87
88     virtual bool scroll(ScrollbarOrientation, ScrollGranularity, float step, float multiplier);
89     virtual void scrollToOffsetWithoutAnimation(const FloatPoint&);
90
91 #if ENABLE(RUBBER_BANDING)
92     virtual bool handleWheelEvent(const PlatformWheelEvent&) OVERRIDE;
93 #if ENABLE(GESTURE_EVENTS)
94     virtual void handleGestureEvent(const PlatformGestureEvent&);
95 #endif
96 #endif
97
98     virtual void cancelAnimations();
99     virtual void setIsActive();
100     
101     virtual void notifyPositionChanged();
102     virtual void contentAreaWillPaint() const;
103     virtual void mouseEnteredContentArea() const;
104     virtual void mouseExitedContentArea() const;
105     virtual void mouseMovedInContentArea() const;
106     virtual void mouseEnteredScrollbar(Scrollbar*) const;
107     virtual void mouseExitedScrollbar(Scrollbar*) const;
108     virtual void willStartLiveResize();
109     virtual void contentsResized() const;
110     virtual void willEndLiveResize();
111     virtual void contentAreaDidShow() const;
112     virtual void contentAreaDidHide() const;
113     void didBeginScrollGesture() const;
114     void didEndScrollGesture() const;
115
116     virtual void didAddVerticalScrollbar(Scrollbar*);
117     virtual void willRemoveVerticalScrollbar(Scrollbar*);
118     virtual void didAddHorizontalScrollbar(Scrollbar*);
119     virtual void willRemoveHorizontalScrollbar(Scrollbar*);
120
121     float adjustScrollXPositionIfNecessary(float) const;
122     float adjustScrollYPositionIfNecessary(float) const;
123     FloatPoint adjustScrollPositionIfNecessary(const FloatPoint&) const;
124
125     void immediateScrollTo(const FloatPoint&);
126     void immediateScrollBy(const FloatSize&);
127     void immediateScrollByWithoutContentEdgeConstraints(const FloatSize&);
128
129 #if ENABLE(RUBBER_BANDING)
130     /// ScrollElasticityControllerClient member functions.
131     virtual IntSize stretchAmount() OVERRIDE;
132     virtual void startSnapRubberbandTimer() OVERRIDE;
133     virtual void stopSnapRubberbandTimer() OVERRIDE;
134
135     bool allowsVerticalStretching() const;
136     bool allowsHorizontalStretching() const;
137     bool pinnedInDirection(float deltaX, float deltaY);
138     void snapRubberBand();
139     void snapRubberBandTimerFired(Timer<ScrollAnimatorMac>*);
140     void smoothScrollWithEvent(const PlatformWheelEvent&);
141     void beginScrollGesture();
142     void endScrollGesture();
143
144     ScrollElasticityController m_scrollElasticityController;
145     Timer<ScrollAnimatorMac> m_snapRubberBandTimer;
146
147     bool m_scrollerInitiallyPinnedOnLeft;
148     bool m_scrollerInitiallyPinnedOnRight;
149     int m_cumulativeHorizontalScroll;
150     bool m_didCumulativeHorizontalScrollEverSwitchToOppositeDirectionOfPin;
151 #endif
152
153     bool m_haveScrolledSincePageLoad;
154     bool m_needsScrollerStyleUpdate;
155     IntRect m_visibleScrollerThumbRect;
156 };
157
158 } // namespace WebCore
159
160 #endif // ENABLE(SMOOTH_SCROLLING)
161
162 #endif // ScrollAnimatorMac_h