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