2010-11-17 Andreas Kling <kling@webkit.org>
[WebKit-https.git] / WebCore / platform / ScrollView.h
1 /*
2  * Copyright (C) 2004, 2006, 2007, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2009 Holger Hans Peter Freyther
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef ScrollView_h
28 #define ScrollView_h
29
30 #include "IntRect.h"
31 #include "Scrollbar.h"
32 #include "ScrollbarClient.h"
33 #include "ScrollTypes.h"
34 #include "Widget.h"
35
36 #include <wtf/HashSet.h>
37
38 #if PLATFORM(MAC) && defined __OBJC__
39 @protocol WebCoreFrameScrollView;
40 #endif
41
42 #if PLATFORM(GTK)
43 #include "GRefPtrGtk.h"
44 typedef struct _GtkAdjustment GtkAdjustment;
45 #endif
46
47 #if PLATFORM(WX)
48 class wxScrollWinEvent;
49 #endif
50
51 namespace WebCore {
52
53 class HostWindow;
54 class PlatformWheelEvent;
55 class Scrollbar;
56
57 class ScrollView : public Widget, public ScrollbarClient {
58 public:
59     ~ScrollView();
60
61     // ScrollbarClient functions.  FrameView overrides the others.
62     virtual int scrollSize(ScrollbarOrientation orientation) const;
63     virtual void setScrollOffsetFromAnimation(const IntPoint&);
64     virtual void valueChanged(Scrollbar*);
65     virtual void valueChanged(const IntSize&);
66     
67     // The window thats hosts the ScrollView. The ScrollView will communicate scrolls and repaints to the
68     // host window in the window's coordinate space.
69     virtual HostWindow* hostWindow() const = 0;
70
71     // Returns a clip rect in host window coordinates. Used to clip the blit on a scroll.
72     virtual IntRect windowClipRect(bool clipToContents = true) const = 0;
73
74     // Functions for child manipulation and inspection.
75     const HashSet<RefPtr<Widget> >* children() const { return &m_children; }
76     void addChild(PassRefPtr<Widget>);
77     void removeChild(Widget*);
78     
79     // If the scroll view does not use a native widget, then it will have cross-platform Scrollbars. These functions
80     // can be used to obtain those scrollbars.
81     Scrollbar* horizontalScrollbar() const { return m_horizontalScrollbar.get(); }
82     Scrollbar* verticalScrollbar() const { return m_verticalScrollbar.get(); }
83     bool isScrollViewScrollbar(const Widget* child) const { return horizontalScrollbar() == child || verticalScrollbar() == child; }
84
85     // Functions for setting and retrieving the scrolling mode in each axis (horizontal/vertical). The mode has values of
86     // AlwaysOff, AlwaysOn, and Auto. AlwaysOff means never show a scrollbar, AlwaysOn means always show a scrollbar.
87     // Auto means show a scrollbar only when one is needed.
88     // Note that for platforms with native widgets, these modes are considered advisory. In other words the underlying native
89     // widget may choose not to honor the requested modes.
90     void setScrollbarModes(ScrollbarMode horizontalMode, ScrollbarMode verticalMode, bool horizontalLock = false, bool verticalLock = false);
91     void setHorizontalScrollbarMode(ScrollbarMode mode, bool lock = false) { setScrollbarModes(mode, verticalScrollbarMode(), lock, verticalScrollbarLock()); }
92     void setVerticalScrollbarMode(ScrollbarMode mode, bool lock = false) { setScrollbarModes(horizontalScrollbarMode(), mode, horizontalScrollbarLock(), lock); };
93     void scrollbarModes(ScrollbarMode& horizontalMode, ScrollbarMode& verticalMode) const;
94     ScrollbarMode horizontalScrollbarMode() const { ScrollbarMode horizontal, vertical; scrollbarModes(horizontal, vertical); return horizontal; }
95     ScrollbarMode verticalScrollbarMode() const { ScrollbarMode horizontal, vertical; scrollbarModes(horizontal, vertical); return vertical; }
96
97     void setHorizontalScrollbarLock(bool lock = true) { m_horizontalScrollbarLock = lock; }
98     bool horizontalScrollbarLock() const { return m_horizontalScrollbarLock; }
99     void setVerticalScrollbarLock(bool lock = true) { m_verticalScrollbarLock = lock; }
100     bool verticalScrollbarLock() const { return m_verticalScrollbarLock; }
101
102     void setScrollingModesLock(bool lock = true) { m_horizontalScrollbarLock = m_verticalScrollbarLock = lock; }
103
104     virtual void setCanHaveScrollbars(bool);
105     bool canHaveScrollbars() const { return horizontalScrollbarMode() != ScrollbarAlwaysOff || verticalScrollbarMode() != ScrollbarAlwaysOff; }
106
107     virtual bool delegatesScrolling() { return false; }
108     virtual bool avoidScrollbarCreation() { return false; }
109
110     // By default you only receive paint events for the area that is visible. In the case of using a
111     // tiled backing store, this function can be set, so that the view paints the entire contents.
112     bool paintsEntireContents() const { return m_paintsEntireContents; }
113     void setPaintsEntireContents(bool);
114
115     // Overridden by FrameView to create custom CSS scrollbars if applicable.
116     virtual PassRefPtr<Scrollbar> createScrollbar(ScrollbarOrientation);
117
118     // If the prohibits scrolling flag is set, then all scrolling in the view (even programmatic scrolling) is turned off.
119     void setProhibitsScrolling(bool b) { m_prohibitsScrolling = b; }
120     bool prohibitsScrolling() const { return m_prohibitsScrolling; }
121
122     // Whether or not a scroll view will blit visible contents when it is scrolled. Blitting is disabled in situations
123     // where it would cause rendering glitches (such as with fixed backgrounds or when the view is partially transparent).
124     void setCanBlitOnScroll(bool);
125     bool canBlitOnScroll() const;
126
127     // The visible content rect has a location that is the scrolled offset of the document. The width and height are the viewport width
128     // and height. By default the scrollbars themselves are excluded from this rectangle, but an optional boolean argument allows them to be
129     // included.
130     // In the situation the client is responsible for the scrolling (ie. with a tiled backing store) it is possible to use
131     // the actualVisibleContentRect instead, though this must be updated manually, e.g after panning ends.
132     IntRect visibleContentRect(bool includeScrollbars = false) const;
133     IntRect actualVisibleContentRect() const { return m_actualVisibleContentRect.isEmpty() ? visibleContentRect() : m_actualVisibleContentRect; }
134     void setActualVisibleContentRect(const IntRect& actualVisibleContentRect) { m_actualVisibleContentRect = actualVisibleContentRect; }
135     int visibleWidth() const { return visibleContentRect().width(); }
136     int visibleHeight() const { return visibleContentRect().height(); }
137
138     // Functions for getting/setting the size webkit should use to layout the contents. By default this is the same as the visible
139     // content size. Explicitly setting a layout size value will cause webkit to layout the contents using this size instead.
140     int layoutWidth() const;
141     int layoutHeight() const;
142     IntSize fixedLayoutSize() const;
143     void setFixedLayoutSize(const IntSize&);
144     bool useFixedLayout() const;
145     void setUseFixedLayout(bool enable);
146     
147     // Functions for getting/setting the size of the document contained inside the ScrollView (as an IntSize or as individual width and height
148     // values).
149     IntSize contentsSize() const; // Always at least as big as the visibleWidth()/visibleHeight().
150     int contentsWidth() const { return contentsSize().width(); }
151     int contentsHeight() const { return contentsSize().height(); }
152     virtual void setContentsSize(const IntSize&);
153    
154     // Functions for querying the current scrolled position (both as a point, a size, or as individual X and Y values).
155     IntPoint scrollPosition() const { return visibleContentRect().location(); }
156     IntSize scrollOffset() const { return visibleContentRect().location() - IntPoint(); } // Gets the scrolled position as an IntSize. Convenient for adding to other sizes.
157     IntPoint maximumScrollPosition() const; // The maximum position we can be scrolled to.
158     int scrollX() const { return scrollPosition().x(); }
159     int scrollY() const { return scrollPosition().y(); }
160     
161     // Functions for scrolling the view.
162     void setScrollPosition(const IntPoint&);
163     void scrollBy(const IntSize& s) { return setScrollPosition(scrollPosition() + s); }
164
165     // This function scrolls by lines, pages or pixels.
166     bool scroll(ScrollDirection, ScrollGranularity);
167         
168     // Scroll the actual contents of the view (either blitting or invalidating as needed).
169     void scrollContents(const IntSize& scrollDelta);
170
171     // This gives us a means of blocking painting on our scrollbars until the first layout has occurred.
172     void setScrollbarsSuppressed(bool suppressed, bool repaintOnUnsuppress = false);
173     bool scrollbarsSuppressed() const { return m_scrollbarsSuppressed; }
174
175     // Event coordinates are assumed to be in the coordinate space of a window that contains
176     // the entire widget hierarchy. It is up to the platform to decide what the precise definition
177     // of containing window is. (For example on Mac it is the containing NSWindow.)
178     IntPoint windowToContents(const IntPoint&) const;
179     IntPoint contentsToWindow(const IntPoint&) const;
180     IntRect windowToContents(const IntRect&) const;
181     IntRect contentsToWindow(const IntRect&) const;
182
183     // Functions for converting to and from screen coordinates.
184     IntRect contentsToScreen(const IntRect&) const;
185     IntPoint screenToContents(const IntPoint&) const;
186
187     // The purpose of this function is to answer whether or not the scroll view is currently visible. Animations and painting updates can be suspended if
188     // we know that we are either not in a window right now or if that window is not visible.
189     bool isOffscreen() const;
190     
191     // These functions are used to enable scrollbars to avoid window resizer controls that overlap the scroll view. This happens on Mac
192     // for example.
193     virtual IntRect windowResizerRect() const { return IntRect(); }
194     bool containsScrollbarsAvoidingResizer() const;
195     void adjustScrollbarsAvoidingResizerCount(int overlapDelta);
196     void windowResizerRectChanged();
197
198     virtual void setParent(ScrollView*); // Overridden to update the overlapping scrollbar count.
199
200     // Called when our frame rect changes (or the rect/scroll position of an ancestor changes).
201     virtual void frameRectsChanged();
202     
203     // Widget override to update our scrollbars and notify our contents of the resize.
204     virtual void setFrameRect(const IntRect&);
205
206     // For platforms that need to hit test scrollbars from within the engine's event handlers (like Win32).
207     Scrollbar* scrollbarAtPoint(const IntPoint& windowPoint);
208
209     // This function exists for scrollviews that need to handle wheel events manually.
210     // On Mac the underlying NSScrollView just does the scrolling, but on other platforms
211     // (like Windows), we need this function in order to do the scroll ourselves.
212     void wheelEvent(PlatformWheelEvent&);
213
214     IntPoint convertChildToSelf(const Widget* child, const IntPoint& point) const
215     {
216         IntPoint newPoint = point;
217         if (!isScrollViewScrollbar(child))
218             newPoint = point - scrollOffset();
219         newPoint.move(child->x(), child->y());
220         return newPoint;
221     }
222
223     IntPoint convertSelfToChild(const Widget* child, const IntPoint& point) const
224     {
225         IntPoint newPoint = point;
226         if (!isScrollViewScrollbar(child))
227             newPoint = point + scrollOffset();
228         newPoint.move(-child->x(), -child->y());
229         return newPoint;
230     }
231
232     // Widget override. Handles painting of the contents of the view as well as the scrollbars.
233     virtual void paint(GraphicsContext*, const IntRect&);
234     void paintScrollbars(GraphicsContext*, const IntRect&);
235
236     // Widget overrides to ensure that our children's visibility status is kept up to date when we get shown and hidden.
237     virtual void show();
238     virtual void hide();
239     virtual void setParentVisible(bool);
240     
241     // Pan scrolling.
242     static const int noPanScrollRadius = 15;
243     void addPanScrollIcon(const IntPoint&);
244     void removePanScrollIcon();
245     void paintPanScrollIcon(GraphicsContext*);
246
247     virtual bool isPointInScrollbarCorner(const IntPoint&);
248     virtual bool scrollbarCornerPresent() const;
249
250     virtual IntRect convertFromScrollbarToContainingView(const Scrollbar*, const IntRect&) const;
251     virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar*, const IntRect&) const;
252     virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar*, const IntPoint&) const;
253     virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar*, const IntPoint&) const;
254
255 protected:
256     ScrollView();
257
258     virtual void repaintContentRectangle(const IntRect&, bool now = false);
259     virtual void paintContents(GraphicsContext*, const IntRect& damageRect) = 0;
260     
261     virtual void contentsResized() = 0;
262     virtual void visibleContentsResized() = 0;
263
264     // These functions are used to create/destroy scrollbars.
265     void setHasHorizontalScrollbar(bool);
266     void setHasVerticalScrollbar(bool);
267
268     IntRect scrollCornerRect() const;
269     virtual void updateScrollCorner();
270     virtual void paintScrollCorner(GraphicsContext*, const IntRect& cornerRect);
271
272     // Scroll the content by blitting the pixels.
273     virtual bool scrollContentsFastPath(const IntSize& scrollDelta, const IntRect& rectToScroll, const IntRect& clipRect);
274     // Scroll the content by invalidating everything.
275     virtual void scrollContentsSlowPath(const IntRect& updateRect);
276
277 private:
278     RefPtr<Scrollbar> m_horizontalScrollbar;
279     RefPtr<Scrollbar> m_verticalScrollbar;
280     ScrollbarMode m_horizontalScrollbarMode;
281     ScrollbarMode m_verticalScrollbarMode;
282
283     bool m_horizontalScrollbarLock;
284     bool m_verticalScrollbarLock;
285
286     bool m_prohibitsScrolling;
287
288     HashSet<RefPtr<Widget> > m_children;
289
290     // This bool is unused on Mac OS because we directly ask the platform widget
291     // whether it is safe to blit on scroll.
292     bool m_canBlitOnScroll;
293
294     IntRect m_actualVisibleContentRect;
295     IntSize m_scrollOffset; // FIXME: Would rather store this as a position, but we will wait to make this change until more code is shared.
296     IntSize m_fixedLayoutSize;
297     IntSize m_contentsSize;
298
299     int m_scrollbarsAvoidingResizer;
300     bool m_scrollbarsSuppressed;
301
302     bool m_inUpdateScrollbars;
303     unsigned m_updateScrollbarsPass;
304
305     IntPoint m_panScrollIconPoint;
306     bool m_drawPanScrollIcon;
307     bool m_useFixedLayout;
308
309     bool m_paintsEntireContents;
310
311     void init();
312     void destroy();
313
314     // Called to update the scrollbars to accurately reflect the state of the view.
315     void updateScrollbars(const IntSize& desiredOffset);
316
317     // Called when the scroll position within this view changes.  FrameView overrides this to generate repaint invalidations.
318     virtual void repaintFixedElementsAfterScrolling() {}
319
320     void platformInit();
321     void platformDestroy();
322     void platformAddChild(Widget*);
323     void platformRemoveChild(Widget*);
324     void platformSetScrollbarModes();
325     void platformScrollbarModes(ScrollbarMode& horizontal, ScrollbarMode& vertical) const;
326     void platformSetCanBlitOnScroll(bool);
327     bool platformCanBlitOnScroll() const;
328     IntRect platformVisibleContentRect(bool includeScrollbars) const;
329     IntSize platformContentsSize() const;
330     void platformSetContentsSize();
331     IntRect platformContentsToScreen(const IntRect&) const;
332     IntPoint platformScreenToContents(const IntPoint&) const;
333     void platformSetScrollPosition(const IntPoint&);
334     bool platformScroll(ScrollDirection, ScrollGranularity);
335     void platformSetScrollbarsSuppressed(bool repaintOnUnsuppress);
336     void platformRepaintContentRectangle(const IntRect&, bool now);
337     bool platformIsOffscreen() const;
338
339 #if PLATFORM(MAC) && defined __OBJC__
340 public:
341     NSView* documentView() const;
342
343 private:
344     NSScrollView<WebCoreFrameScrollView>* scrollView() const;
345 #endif
346
347 #if PLATFORM(GTK)
348 public:
349     void setGtkAdjustments(GtkAdjustment* hadj, GtkAdjustment* vadj, bool resetValues = true);
350     void setHorizontalAdjustment(GtkAdjustment* hadj, bool resetValues = true);
351     void setVerticalAdjustment(GtkAdjustment* vadj, bool resetValues = true);
352     void setScrollOffset(const IntSize& offset) { m_scrollOffset = offset; }
353
354 private:
355     PlatformRefPtr<GtkAdjustment> m_horizontalAdjustment;
356     PlatformRefPtr<GtkAdjustment> m_verticalAdjustment;
357 #endif
358
359 #if PLATFORM(WX)
360 public:
361     virtual void setPlatformWidget(wxWindow*);
362     void adjustScrollbars(int x = -1, int y = -1, bool refresh = true);
363 private:
364     class ScrollViewPrivate;
365     ScrollViewPrivate* m_data;
366 #endif
367
368 }; // class ScrollView
369
370 } // namespace WebCore
371
372 #endif // ScrollView_h