Add basic rubber banding support
[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 "IntRect.h"
30 #include "Scrollbar.h"
31 #include <wtf/Vector.h>
32
33 namespace WebCore {
34
35 class FloatPoint;
36 class PlatformWheelEvent;
37 class ScrollAnimator;
38
39 #if ENABLE(GESTURE_EVENTS)
40 class PlatformGestureEvent;
41 #endif
42
43 class ScrollableArea {
44 public:
45     ScrollableArea();
46     virtual ~ScrollableArea();
47
48     bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1);
49     void scrollToOffsetWithoutAnimation(const FloatPoint&);
50     void scrollToOffsetWithoutAnimation(ScrollbarOrientation, float offset);
51     void scrollToXOffsetWithoutAnimation(float x);
52     void scrollToYOffsetWithoutAnimation(float x);
53
54     void handleWheelEvent(PlatformWheelEvent&);
55 #if ENABLE(GESTURE_EVENTS)
56     void handleGestureEvent(const PlatformGestureEvent&);
57 #endif
58
59     // Functions for controlling if you can scroll past the end of the document.
60     bool constrainsScrollingToContentEdge() const { return m_constrainsScrollingToContentEdge; }
61     void setConstrainsScrollingToContentEdge(bool constrainsScrollingToContentEdge) { m_constrainsScrollingToContentEdge = constrainsScrollingToContentEdge; }
62
63     virtual int scrollSize(ScrollbarOrientation) const = 0;
64     virtual int scrollPosition(Scrollbar*) const = 0;
65     virtual void invalidateScrollbarRect(Scrollbar*, const IntRect&) = 0;
66     virtual bool isActive() const = 0;
67     virtual bool scrollbarCornerPresent() const = 0;
68     virtual void getTickmarks(Vector<IntRect>&) const { }
69
70     // This function should be overriden by subclasses to perform the actual
71     // scroll of the content.
72     virtual void setScrollOffset(const IntPoint&) = 0;
73
74
75     // Convert points and rects between the scrollbar and its containing view.
76     // The client needs to implement these in order to be aware of layout effects
77     // like CSS transforms.
78     virtual IntRect convertFromScrollbarToContainingView(const Scrollbar* scrollbar, const IntRect& scrollbarRect) const
79     {
80         return scrollbar->Widget::convertToContainingView(scrollbarRect);
81     }
82     virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar* scrollbar, const IntRect& parentRect) const
83     {
84         return scrollbar->Widget::convertFromContainingView(parentRect);
85     }
86     virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar* scrollbar, const IntPoint& scrollbarPoint) const
87     {
88         return scrollbar->Widget::convertToContainingView(scrollbarPoint);
89     }
90     virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar* scrollbar, const IntPoint& parentPoint) const
91     {
92         return scrollbar->Widget::convertFromContainingView(parentPoint);
93     }
94
95     virtual Scrollbar* horizontalScrollbar() const { return 0; }
96     virtual Scrollbar* verticalScrollbar() const { return 0; }
97
98     virtual IntPoint scrollPosition() const { ASSERT_NOT_REACHED(); return IntPoint(); }
99     virtual IntPoint minimumScrollPosition() const { ASSERT_NOT_REACHED(); return IntPoint(); }
100     virtual IntPoint maximumScrollPosition() const { ASSERT_NOT_REACHED(); return IntPoint(); }
101
102     virtual IntRect visibleContentRect(bool = false) const { ASSERT_NOT_REACHED(); return IntRect(); }
103     virtual int visibleHeight() const { ASSERT_NOT_REACHED(); return 0; }
104     virtual int visibleWidth() const { ASSERT_NOT_REACHED(); return 0; }
105
106     virtual IntSize contentsSize() const { ASSERT_NOT_REACHED(); return IntSize(); }
107
108     virtual IntSize overhangAmount() const { ASSERT_NOT_REACHED(); return IntSize(); }
109
110 private:
111     // NOTE: Only called from the ScrollAnimator.
112     friend class ScrollAnimator;
113     void setScrollOffsetFromAnimation(const IntPoint&);
114
115     OwnPtr<ScrollAnimator> m_scrollAnimator;
116     bool m_constrainsScrollingToContentEdge;
117 };
118
119 } // namespace WebCore
120
121 #endif // ScrollableArea_h