358bd8f78d32e1511a25f381a969c8e29905023f
[WebKit-https.git] / Source / WebCore / platform / ScrollableArea.h
1 /*
2  * Copyright (C) 2008, 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef ScrollableArea_h
27 #define ScrollableArea_h
28
29 #include "Scrollbar.h"
30 #include <wtf/Vector.h>
31
32 namespace WebCore {
33
34 class FloatPoint;
35 class GraphicsContext;
36 class PlatformGestureEvent;
37 class PlatformWheelEvent;
38 class ScrollAnimator;
39 #if USE(ACCELERATED_COMPOSITING)
40 class GraphicsLayer;
41 class TiledBacking;
42 #endif
43
44 class ScrollableArea {
45 public:
46     bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1);
47     void scrollToOffsetWithoutAnimation(const FloatPoint&);
48     void scrollToOffsetWithoutAnimation(ScrollbarOrientation, float offset);
49
50     // Should be called when the scroll position changes externally, for example if the scroll layer position
51     // is updated on the scrolling thread and we need to notify the main thread.
52     void notifyScrollPositionChanged(const IntPoint&);
53
54     // Allows subclasses to handle scroll position updates themselves. If this member function
55     // returns true, the scrollable area won't actually update the scroll position and instead
56     // expect it to happen sometime in the future.
57     virtual bool requestScrollPositionUpdate(const IntPoint&) { return false; }
58
59     bool handleWheelEvent(const PlatformWheelEvent&);
60
61     // Functions for controlling if you can scroll past the end of the document.
62     bool constrainsScrollingToContentEdge() const { return m_constrainsScrollingToContentEdge; }
63     void setConstrainsScrollingToContentEdge(bool constrainsScrollingToContentEdge) { m_constrainsScrollingToContentEdge = constrainsScrollingToContentEdge; }
64
65     void setVerticalScrollElasticity(ScrollElasticity scrollElasticity) { m_verticalScrollElasticity = scrollElasticity; }
66     ScrollElasticity verticalScrollElasticity() const { return static_cast<ScrollElasticity>(m_verticalScrollElasticity); }
67
68     void setHorizontalScrollElasticity(ScrollElasticity scrollElasticity) { m_horizontalScrollElasticity = scrollElasticity; }
69     ScrollElasticity horizontalScrollElasticity() const { return static_cast<ScrollElasticity>(m_horizontalScrollElasticity); }
70
71     bool inLiveResize() const { return m_inLiveResize; }
72     void willStartLiveResize();
73     void willEndLiveResize();
74
75     void contentAreaWillPaint() const;
76     void mouseEnteredContentArea() const;
77     void mouseExitedContentArea() const;
78     void mouseMovedInContentArea() const;
79     void mouseEnteredScrollbar(Scrollbar*) const;
80     void mouseExitedScrollbar(Scrollbar*) const;
81     void contentAreaDidShow() const;
82     void contentAreaDidHide() const;
83
84     void finishCurrentScrollAnimations() const;
85
86     void didAddVerticalScrollbar(Scrollbar*);
87     void willRemoveVerticalScrollbar(Scrollbar*);
88     virtual void didAddHorizontalScrollbar(Scrollbar*);
89     virtual void willRemoveHorizontalScrollbar(Scrollbar*);
90
91     virtual void contentsResized();
92
93     bool hasOverlayScrollbars() const;
94     virtual void setScrollbarOverlayStyle(ScrollbarOverlayStyle);
95     ScrollbarOverlayStyle scrollbarOverlayStyle() const { return static_cast<ScrollbarOverlayStyle>(m_scrollbarOverlayStyle); }
96
97     // This getter will create a ScrollAnimator if it doesn't already exist.
98     ScrollAnimator* scrollAnimator() const;
99
100     // This getter will return null if the ScrollAnimator hasn't been created yet.
101     ScrollAnimator* existingScrollAnimator() const { return m_scrollAnimator.get(); }
102
103     const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
104     bool scrollOriginChanged() const { return m_scrollOriginChanged; }
105
106     virtual bool isActive() const = 0;
107     virtual int scrollSize(ScrollbarOrientation) const = 0;
108     virtual int scrollPosition(Scrollbar*) const = 0;
109     virtual void invalidateScrollbar(Scrollbar*, const IntRect&);
110     virtual bool isScrollCornerVisible() const = 0;
111     virtual IntRect scrollCornerRect() const = 0;
112     virtual void invalidateScrollCorner(const IntRect&);
113     virtual void getTickmarks(Vector<IntRect>&) const { }
114
115     // Convert points and rects between the scrollbar and its containing view.
116     // The client needs to implement these in order to be aware of layout effects
117     // like CSS transforms.
118     virtual IntRect convertFromScrollbarToContainingView(const Scrollbar* scrollbar, const IntRect& scrollbarRect) const
119     {
120         return scrollbar->Widget::convertToContainingView(scrollbarRect);
121     }
122     virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar* scrollbar, const IntRect& parentRect) const
123     {
124         return scrollbar->Widget::convertFromContainingView(parentRect);
125     }
126     virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar* scrollbar, const IntPoint& scrollbarPoint) const
127     {
128         return scrollbar->Widget::convertToContainingView(scrollbarPoint);
129     }
130     virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar* scrollbar, const IntPoint& parentPoint) const
131     {
132         return scrollbar->Widget::convertFromContainingView(parentPoint);
133     }
134
135     virtual Scrollbar* horizontalScrollbar() const { return 0; }
136     virtual Scrollbar* verticalScrollbar() const { return 0; }
137
138     virtual IntPoint scrollPosition() const;
139     virtual IntPoint minimumScrollPosition() const;
140     virtual IntPoint maximumScrollPosition() const;
141
142     enum VisibleContentRectIncludesScrollbars { ExcludeScrollbars, IncludeScrollbars };
143     virtual IntRect visibleContentRect(VisibleContentRectIncludesScrollbars = ExcludeScrollbars) const;
144     virtual int visibleHeight() const = 0;
145     virtual int visibleWidth() const = 0;
146     virtual IntSize contentsSize() const = 0;
147     virtual IntSize overhangAmount() const { return IntSize(); }
148     virtual IntPoint lastKnownMousePosition() const { return IntPoint(); }
149
150     virtual bool shouldSuspendScrollAnimations() const { return true; }
151     virtual void scrollbarStyleChanged(int /*newStyle*/, bool /*forceUpdate*/) { }
152     virtual void setVisibleScrollerThumbRect(const IntRect&) { }
153
154     virtual bool scrollbarsCanBeActive() const = 0;
155     
156     // Note that this only returns scrollable areas that can actually be scrolled.
157     virtual ScrollableArea* enclosingScrollableArea() const = 0;
158
159     // Returns the bounding box of this scrollable area, in the coordinate system of the enclosing scroll view.
160     virtual IntRect scrollableAreaBoundingBox() const = 0;
161
162     virtual bool shouldRubberBandInDirection(ScrollDirection) const { return true; }
163     virtual bool isRubberBandInProgress() const { return false; }
164
165     virtual bool scrollAnimatorEnabled() const { return false; }
166
167     // NOTE: Only called from Internals for testing.
168     void setScrollOffsetFromInternals(const IntPoint&);
169
170     // Let subclasses provide a way of asking for and servicing scroll
171     // animations.
172     virtual bool scheduleAnimation() { return false; }
173     void serviceScrollAnimations();
174
175 #if USE(ACCELERATED_COMPOSITING)
176     virtual TiledBacking* tiledBacking() { return 0; }
177     virtual bool usesCompositedScrolling() const { return false; }
178 #endif
179
180     virtual void reportMemoryUsage(MemoryObjectInfo*) const;
181
182 protected:
183     ScrollableArea();
184     virtual ~ScrollableArea();
185
186     void setScrollOrigin(const IntPoint&);
187     void resetScrollOriginChanged() { m_scrollOriginChanged = false; }
188
189     virtual void invalidateScrollbarRect(Scrollbar*, const IntRect&) = 0;
190     virtual void invalidateScrollCornerRect(const IntRect&) = 0;
191
192 #if USE(ACCELERATED_COMPOSITING)
193     virtual GraphicsLayer* layerForHorizontalScrollbar() const { return 0; }
194     virtual GraphicsLayer* layerForVerticalScrollbar() const { return 0; }
195     virtual GraphicsLayer* layerForScrollCorner() const { return 0; }
196 #if ENABLE(RUBBER_BANDING)
197     virtual GraphicsLayer* layerForOverhangAreas() const { return 0; }
198 #endif
199 #endif
200     bool hasLayerForHorizontalScrollbar() const;
201     bool hasLayerForVerticalScrollbar() const;
202     bool hasLayerForScrollCorner() const;
203
204 private:
205     void scrollPositionChanged(const IntPoint&);
206     
207     // NOTE: Only called from the ScrollAnimator.
208     friend class ScrollAnimator;
209     void setScrollOffsetFromAnimation(const IntPoint&);
210
211     // This function should be overriden by subclasses to perform the actual
212     // scroll of the content.
213     virtual void setScrollOffset(const IntPoint&) = 0;
214
215     mutable OwnPtr<ScrollAnimator> m_scrollAnimator;
216     unsigned m_constrainsScrollingToContentEdge : 1;
217
218     unsigned m_inLiveResize : 1;
219
220     unsigned m_verticalScrollElasticity : 2; // ScrollElasticity
221     unsigned m_horizontalScrollElasticity : 2; // ScrollElasticity
222
223     unsigned m_scrollbarOverlayStyle : 2; // ScrollbarOverlayStyle
224
225     unsigned m_scrollOriginChanged : 1;
226
227     // There are 8 possible combinations of writing mode and direction. Scroll origin will be non-zero in the x or y axis
228     // if there is any reversed direction or writing-mode. The combinations are:
229     // writing-mode / direction     scrollOrigin.x() set    scrollOrigin.y() set
230     // horizontal-tb / ltr          NO                      NO
231     // horizontal-tb / rtl          YES                     NO
232     // horizontal-bt / ltr          NO                      YES
233     // horizontal-bt / rtl          YES                     YES
234     // vertical-lr / ltr            NO                      NO
235     // vertical-lr / rtl            NO                      YES
236     // vertical-rl / ltr            YES                     NO
237     // vertical-rl / rtl            YES                     YES
238     IntPoint m_scrollOrigin;
239 };
240
241 } // namespace WebCore
242
243 #endif // ScrollableArea_h