Part 2 for <rdar://problem/8492788>
[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 "FloatPoint.h"
32 #include "FloatSize.h"
33 #include "ScrollAnimator.h"
34 #include "Timer.h"
35 #include "WebCoreSystemInterface.h"
36 #include <JavaScriptCore/HeaderDetection.h>
37 #include <wtf/RetainPtr.h>
38
39 #ifdef __OBJC__
40 @class ScrollAnimationHelperDelegate;
41 @class ScrollbarPainterDelegate;
42 @class ScrollbarPainterControllerDelegate;
43 @class ScrollbarPainterDelegate;
44 #else
45 class ScrollAnimationHelperDelegate;
46 class ScrollbarPainterDelegate;
47 class ScrollbarPainterControllerDelegate;
48 class ScrollbarPainterDelegate;
49 #endif
50
51 namespace WebCore {
52
53 class Scrollbar;
54
55 class ScrollAnimatorMac : public ScrollAnimator {
56 public:
57     ScrollAnimatorMac(ScrollableArea*);
58     virtual ~ScrollAnimatorMac();
59
60 #if defined(USE_WK_SCROLLBAR_PAINTER_AND_CONTROLLER)
61     void setPainterForPainterController(WKScrollbarPainterRef, bool isHorizontal);
62     void removePainterFromPainterController(ScrollbarOrientation orientation);
63 #endif
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 void handleWheelEvent(PlatformWheelEvent&);
70 #if ENABLE(GESTURE_EVENTS)
71     virtual void handleGestureEvent(const PlatformGestureEvent&);
72 #endif
73 #endif
74
75     void immediateScrollToPoint(const FloatPoint& newPosition);
76     void immediateScrollByDeltaX(float deltaX);
77     void immediateScrollByDeltaY(float deltaY);
78
79     id scrollbarPainterDelegate();
80     
81 private:
82     RetainPtr<id> m_scrollAnimationHelper;
83     RetainPtr<ScrollAnimationHelperDelegate> m_scrollAnimationHelperDelegate;
84
85 #if defined(USE_WK_SCROLLBAR_PAINTER_AND_CONTROLLER)
86     RetainPtr<WKScrollbarPainterControllerRef> m_scrollbarPainterController;
87     RetainPtr<ScrollbarPainterControllerDelegate> m_scrollbarPainterControllerDelegate;
88     RetainPtr<id> m_scrollbarPainterDelegate;
89 #endif
90     
91     virtual void notityPositionChanged();
92     virtual void contentAreaWillPaint() const;
93     virtual void mouseEnteredContentArea() const;
94     virtual void mouseExitedContentArea() const;
95     virtual void mouseMovedInContentArea() const;
96     virtual void willStartLiveResize();
97     virtual void contentsResized() const;
98     virtual void willEndLiveResize();
99     virtual void contentAreaDidShow() const;
100     virtual void contentAreaDidHide() const;
101
102 #if ENABLE(RUBBER_BANDING)
103     bool allowsVerticalStretching() const;
104     bool allowsHorizontalStretching() const;
105     bool pinnedInDirection(float deltaX, float deltaY);
106     void snapRubberBand();
107     void snapRubberBandTimerFired(Timer<ScrollAnimatorMac>*);
108     void smoothScrollWithEvent(PlatformWheelEvent&);
109     void beginScrollGesture();
110     void endScrollGesture();
111
112     bool m_inScrollGesture;
113     bool m_momentumScrollInProgress;
114     bool m_ignoreMomentumScrolls;
115     CFTimeInterval m_lastMomemtumScrollTimestamp;
116     FloatSize m_overflowScrollDelta;
117     FloatSize m_stretchScrollForce;
118     FloatSize m_momentumVelocity;
119
120     // Rubber band state.
121     CFTimeInterval m_startTime;
122     FloatSize m_startStretch;
123     FloatPoint m_origOrigin;
124     FloatSize m_origVelocity;
125     Timer<ScrollAnimatorMac> m_snapRubberBandTimer;
126 #endif
127 };
128
129 } // namespace WebCore
130
131 #endif // ENABLE(SMOOTH_SCROLLING)
132
133 #endif // ScrollAnimatorMac_h