Merge ScrollAnimatorChromiumMac.mm back to ScrollAnimatorMac
[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     virtual bool scroll(ScrollbarOrientation, ScrollGranularity, float step, float multiplier);
66     virtual void scrollToOffsetWithoutAnimation(const FloatPoint&);
67
68 #if ENABLE(RUBBER_BANDING)
69     virtual bool handleWheelEvent(const PlatformWheelEvent&) OVERRIDE;
70 #if ENABLE(GESTURE_EVENTS)
71     virtual void handleGestureEvent(const PlatformGestureEvent&);
72 #endif
73 #endif
74
75     virtual void cancelAnimations();
76
77     void immediateScrollToPoint(const FloatPoint& newPosition);
78     void immediateScrollByDeltaX(float deltaX);
79     void immediateScrollByDeltaY(float deltaY);
80
81     void immediateScrollToPointForScrollAnimation(const FloatPoint& newPosition);
82
83     bool haveScrolledSincePageLoad() const { return m_haveScrolledSincePageLoad; }
84
85     virtual void setIsActive();
86
87     void updateScrollerStyle();
88
89     bool scrollbarPaintTimerIsActive() const;
90     void startScrollbarPaintTimer();
91     void stopScrollbarPaintTimer();
92
93     void setVisibleScrollerThumbRect(const IntRect&);
94
95 private:
96     RetainPtr<id> m_scrollAnimationHelper;
97     RetainPtr<WebScrollAnimationHelperDelegate> m_scrollAnimationHelperDelegate;
98
99     RetainPtr<ScrollbarPainterController> m_scrollbarPainterController;
100     RetainPtr<WebScrollbarPainterControllerDelegate> m_scrollbarPainterControllerDelegate;
101     RetainPtr<WebScrollbarPainterDelegate> m_horizontalScrollbarPainterDelegate;
102     RetainPtr<WebScrollbarPainterDelegate> m_verticalScrollbarPainterDelegate;
103
104     void initialScrollbarPaintTimerFired(Timer<ScrollAnimatorMac>*);
105     Timer<ScrollAnimatorMac> m_initialScrollbarPaintTimer;
106     
107     virtual void notifyPositionChanged();
108     virtual void contentAreaWillPaint() const;
109     virtual void mouseEnteredContentArea() const;
110     virtual void mouseExitedContentArea() const;
111     virtual void mouseMovedInContentArea() const;
112     virtual void mouseEnteredScrollbar(Scrollbar*) const;
113     virtual void mouseExitedScrollbar(Scrollbar*) const;
114     virtual void willStartLiveResize();
115     virtual void contentsResized() const;
116     virtual void willEndLiveResize();
117     virtual void contentAreaDidShow() const;
118     virtual void contentAreaDidHide() const;
119     void didBeginScrollGesture() const;
120     void didEndScrollGesture() const;
121
122     virtual void didAddVerticalScrollbar(Scrollbar*);
123     virtual void willRemoveVerticalScrollbar(Scrollbar*);
124     virtual void didAddHorizontalScrollbar(Scrollbar*);
125     virtual void willRemoveHorizontalScrollbar(Scrollbar*);
126
127     void setNeedsScrollerStyleUpdate(bool needsUpdate) { m_needsScrollerStyleUpdate = needsUpdate; }
128     bool needsScrollerStyleUpdate() const { return m_needsScrollerStyleUpdate; }
129
130     float adjustScrollXPositionIfNecessary(float) const;
131     float adjustScrollYPositionIfNecessary(float) const;
132     FloatPoint adjustScrollPositionIfNecessary(const FloatPoint&) const;
133
134 #if ENABLE(RUBBER_BANDING)
135     /// ScrollElasticityControllerClient member functions.
136     virtual bool isHorizontalScrollerPinnedToMinimumPosition() OVERRIDE;
137     virtual bool isHorizontalScrollerPinnedToMaximumPosition() OVERRIDE;
138     virtual IntSize stretchAmount() OVERRIDE;
139     virtual void startSnapRubberbandTimer() OVERRIDE;
140     virtual void stopSnapRubberbandTimer() OVERRIDE;
141
142     bool allowsVerticalStretching() const;
143     bool allowsHorizontalStretching() const;
144     bool pinnedInDirection(float deltaX, float deltaY);
145     void snapRubberBand();
146     void snapRubberBandTimerFired(Timer<ScrollAnimatorMac>*);
147     void smoothScrollWithEvent(const PlatformWheelEvent&);
148     void beginScrollGesture();
149     void endScrollGesture();
150
151     ScrollElasticityController m_scrollElasticityController;
152     Timer<ScrollAnimatorMac> m_snapRubberBandTimer;
153 #endif
154
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