Fix spelling error.
[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 "Timer.h"
36 #include <wtf/RetainPtr.h>
37
38 #ifdef __OBJC__
39 @class ScrollAnimationHelperDelegate;
40 @class ScrollbarPainterDelegate;
41 @class ScrollbarPainterControllerDelegate;
42 @class ScrollbarPainterDelegate;
43 #else
44 class ScrollAnimationHelperDelegate;
45 class ScrollbarPainterDelegate;
46 class ScrollbarPainterControllerDelegate;
47 class ScrollbarPainterDelegate;
48 #endif
49
50 #if USE(WK_SCROLLBAR_PAINTER)
51 typedef struct __WKScrollbarPainterController *WKScrollbarPainterControllerRef;
52 #endif
53
54 namespace WebCore {
55
56 class Scrollbar;
57
58 class ScrollAnimatorMac : public ScrollAnimator {
59 public:
60     ScrollAnimatorMac(ScrollableArea*);
61     virtual ~ScrollAnimatorMac();
62
63     virtual bool scroll(ScrollbarOrientation, ScrollGranularity, float step, float multiplier);
64     virtual void scrollToOffsetWithoutAnimation(const FloatPoint&);
65
66 #if ENABLE(RUBBER_BANDING)
67     virtual void handleWheelEvent(PlatformWheelEvent&);
68 #if ENABLE(GESTURE_EVENTS)
69     virtual void handleGestureEvent(const PlatformGestureEvent&);
70 #endif
71 #endif
72
73     virtual void cancelAnimations();
74
75     void immediateScrollToPoint(const FloatPoint& newPosition);
76     void immediateScrollByDeltaX(float deltaX);
77     void immediateScrollByDeltaY(float deltaY);
78
79     void immediateScrollToPointForScrollAnimation(const FloatPoint& newPosition);
80
81     void setIsDrawingIntoLayer(bool b) { m_drawingIntoLayer = b; }
82     bool isDrawingIntoLayer() const { return m_drawingIntoLayer; }
83
84     bool haveScrolledSincePageLoad() const { return m_haveScrolledSincePageLoad; }
85
86     virtual void setIsActive();
87
88 #if USE(WK_SCROLLBAR_PAINTER)
89     void updateScrollerStyle();
90
91     bool scrollbarPaintTimerIsActive() const;
92     void startScrollbarPaintTimer();
93     void stopScrollbarPaintTimer();
94 #endif
95
96     void setVisibleScrollerThumbRect(const IntRect&);
97
98 private:
99     RetainPtr<id> m_scrollAnimationHelper;
100     RetainPtr<ScrollAnimationHelperDelegate> m_scrollAnimationHelperDelegate;
101
102 #if USE(WK_SCROLLBAR_PAINTER)
103     RetainPtr<WKScrollbarPainterControllerRef> m_scrollbarPainterController;
104     RetainPtr<ScrollbarPainterControllerDelegate> m_scrollbarPainterControllerDelegate;
105     RetainPtr<id> m_scrollbarPainterDelegate;
106
107     void initialScrollbarPaintTimerFired(Timer<ScrollAnimatorMac>*);
108     Timer<ScrollAnimatorMac> m_initialScrollbarPaintTimer;
109 #endif
110     
111     virtual void notifyPositionChanged();
112     virtual void contentAreaWillPaint() const;
113     virtual void mouseEnteredContentArea() const;
114     virtual void mouseExitedContentArea() const;
115     virtual void mouseMovedInContentArea() const;
116     virtual void willStartLiveResize();
117     virtual void contentsResized() const;
118     virtual void willEndLiveResize();
119     virtual void contentAreaDidShow() const;
120     virtual void contentAreaDidHide() const;
121     void didBeginScrollGesture() const;
122     void didEndScrollGesture() const;
123
124     virtual void didAddVerticalScrollbar(Scrollbar*);
125     virtual void willRemoveVerticalScrollbar(Scrollbar*);
126     virtual void didAddHorizontalScrollbar(Scrollbar*);
127     virtual void willRemoveHorizontalScrollbar(Scrollbar*);
128
129     void setNeedsScrollerStyleUpdate(bool needsUpdate) { m_needsScrollerStyleUpdate = needsUpdate; }
130     bool needsScrollerStyleUpdate() const { return m_needsScrollerStyleUpdate; }
131
132     float adjustScrollXPositionIfNecessary(float) const;
133     float adjustScrollYPositionIfNecessary(float) const;
134     FloatPoint adjustScrollPositionIfNecessary(const FloatPoint&) const;
135
136 #if ENABLE(RUBBER_BANDING)
137     bool allowsVerticalStretching() const;
138     bool allowsHorizontalStretching() const;
139     bool pinnedInDirection(float deltaX, float deltaY);
140     void snapRubberBand();
141     void snapRubberBandTimerFired(Timer<ScrollAnimatorMac>*);
142     void smoothScrollWithEvent(PlatformWheelEvent&);
143     void beginScrollGesture();
144     void endScrollGesture();
145
146     bool m_inScrollGesture;
147     bool m_momentumScrollInProgress;
148     bool m_ignoreMomentumScrolls;
149     bool m_scrollerInitiallyPinnedOnLeft;
150     bool m_scrollerInitiallyPinnedOnRight;
151     int m_cumulativeHorizontalScroll;
152     bool m_didCumulativeHorizontalScrollEverSwitchToOppositeDirectionOfPin;
153     
154     CFTimeInterval m_lastMomentumScrollTimestamp;
155     FloatSize m_overflowScrollDelta;
156     FloatSize m_stretchScrollForce;
157     FloatSize m_momentumVelocity;
158
159     // Rubber band state.
160     CFTimeInterval m_startTime;
161     FloatSize m_startStretch;
162     FloatPoint m_origOrigin;
163     FloatSize m_origVelocity;
164     Timer<ScrollAnimatorMac> m_snapRubberBandTimer;
165 #endif
166     bool m_drawingIntoLayer;
167     bool m_haveScrolledSincePageLoad;
168     bool m_needsScrollerStyleUpdate;
169     IntRect m_visibleScrollerThumbRect;
170 };
171
172 } // namespace WebCore
173
174 #endif // ENABLE(SMOOTH_SCROLLING)
175
176 #endif // ScrollAnimatorMac_h