ec03125cd53b5d011b1a1d7f52b5759950a3dc21
[WebKit-https.git] / Source / 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 "ScrollableArea.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(WX)
43 class wxScrollWinEvent;
44 #endif
45
46 namespace WebCore {
47
48 class HostWindow;
49 class Scrollbar;
50
51 class ScrollView : public Widget, public ScrollableArea {
52 public:
53     ~ScrollView();
54
55     // ScrollableArea functions.  FrameView overrides the others.
56     virtual int scrollSize(ScrollbarOrientation orientation) const;
57     virtual int scrollPosition(Scrollbar*) const;
58     virtual void setScrollOffset(const IntPoint&);
59     virtual void notifyPageThatContentAreaWillPaint() const;
60     virtual bool isScrollCornerVisible() const;
61     virtual void scrollbarStyleChanged(int newStyle, bool forceUpdate);
62
63     // NOTE: This should only be called by the overriden setScrollOffset from ScrollableArea.
64     virtual void scrollTo(const IntSize& newOffset);
65
66     // The window thats hosts the ScrollView. The ScrollView will communicate scrolls and repaints to the
67     // host window in the window's coordinate space.
68     virtual HostWindow* hostWindow() const = 0;
69
70     // Returns a clip rect in host window coordinates. Used to clip the blit on a scroll.
71     virtual IntRect windowClipRect(bool clipToContents = true) const = 0;
72
73     // Functions for child manipulation and inspection.
74     const HashSet<RefPtr<Widget> >* children() const { return &m_children; }
75     virtual void addChild(PassRefPtr<Widget>);
76     virtual void removeChild(Widget*);
77     
78     // If the scroll view does not use a native widget, then it will have cross-platform Scrollbars. These functions
79     // can be used to obtain those scrollbars.
80     virtual Scrollbar* horizontalScrollbar() const { return m_horizontalScrollbar.get(); }
81     virtual Scrollbar* verticalScrollbar() const { return m_verticalScrollbar.get(); }
82     bool isScrollViewScrollbar(const Widget* child) const { return horizontalScrollbar() == child || verticalScrollbar() == child; }
83
84     void positionScrollbarLayers();
85
86     // Functions for setting and retrieving the scrolling mode in each axis (horizontal/vertical). The mode has values of
87     // AlwaysOff, AlwaysOn, and Auto. AlwaysOff means never show a scrollbar, AlwaysOn means always show a scrollbar.
88     // Auto means show a scrollbar only when one is needed.
89     // Note that for platforms with native widgets, these modes are considered advisory. In other words the underlying native
90     // widget may choose not to honor the requested modes.
91     void setScrollbarModes(ScrollbarMode horizontalMode, ScrollbarMode verticalMode, bool horizontalLock = false, bool verticalLock = false);
92     void setHorizontalScrollbarMode(ScrollbarMode mode, bool lock = false) { setScrollbarModes(mode, verticalScrollbarMode(), lock, verticalScrollbarLock()); }
93     void setVerticalScrollbarMode(ScrollbarMode mode, bool lock = false) { setScrollbarModes(horizontalScrollbarMode(), mode, horizontalScrollbarLock(), lock); };
94     void scrollbarModes(ScrollbarMode& horizontalMode, ScrollbarMode& verticalMode) const;
95     ScrollbarMode horizontalScrollbarMode() const { ScrollbarMode horizontal, vertical; scrollbarModes(horizontal, vertical); return horizontal; }
96     ScrollbarMode verticalScrollbarMode() const { ScrollbarMode horizontal, vertical; scrollbarModes(horizontal, vertical); return vertical; }
97
98     void setHorizontalScrollbarLock(bool lock = true) { m_horizontalScrollbarLock = lock; }
99     bool horizontalScrollbarLock() const { return m_horizontalScrollbarLock; }
100     void setVerticalScrollbarLock(bool lock = true) { m_verticalScrollbarLock = lock; }
101     bool verticalScrollbarLock() const { return m_verticalScrollbarLock; }
102
103     void setScrollingModesLock(bool lock = true) { m_horizontalScrollbarLock = m_verticalScrollbarLock = lock; }
104
105     virtual void setCanHaveScrollbars(bool);
106     bool canHaveScrollbars() const { return horizontalScrollbarMode() != ScrollbarAlwaysOff || verticalScrollbarMode() != ScrollbarAlwaysOff; }
107
108     virtual bool avoidScrollbarCreation() const { return false; }
109
110     virtual void setScrollbarOverlayStyle(ScrollbarOverlayStyle);
111
112     // By default you only receive paint events for the area that is visible. In the case of using a
113     // tiled backing store, this function can be set, so that the view paints the entire contents.
114     bool paintsEntireContents() const { return m_paintsEntireContents; }
115     void setPaintsEntireContents(bool);
116
117     // By default, paint events are clipped to the visible area.  If set to
118     // false, paint events are no longer clipped.  paintsEntireContents() implies !clipsRepaints().
119     bool clipsRepaints() const { return m_clipsRepaints; }
120     void setClipsRepaints(bool);
121
122     // By default programmatic scrolling is handled by WebCore and not by the UI application.
123     // In the case of using a tiled backing store, this mode can be set, so that the scroll requests
124     // are delegated to the UI application.
125     bool delegatesScrolling() const { return m_delegatesScrolling; }
126     void setDelegatesScrolling(bool);
127
128     // Overridden by FrameView to create custom CSS scrollbars if applicable.
129     virtual PassRefPtr<Scrollbar> createScrollbar(ScrollbarOrientation);
130
131     // If the prohibits scrolling flag is set, then all scrolling in the view (even programmatic scrolling) is turned off.
132     void setProhibitsScrolling(bool b) { m_prohibitsScrolling = b; }
133     bool prohibitsScrolling() const { return m_prohibitsScrolling; }
134
135     // Whether or not a scroll view will blit visible contents when it is scrolled. Blitting is disabled in situations
136     // where it would cause rendering glitches (such as with fixed backgrounds or when the view is partially transparent).
137     void setCanBlitOnScroll(bool);
138     bool canBlitOnScroll() const;
139
140     // The visible content rect has a location that is the scrolled offset of the document. The width and height are the viewport width
141     // and height. By default the scrollbars themselves are excluded from this rectangle, but an optional boolean argument allows them to be
142     // included.
143     // In the situation the client is responsible for the scrolling (ie. with a tiled backing store) it is possible to use
144     // the setFixedVisibleContentRect instead for the mainframe, though this must be updated manually, e.g just before resuming the page
145     // which usually will happen when panning, pinching and rotation ends, or when scale or position are changed manually.
146     virtual IntRect visibleContentRect(bool includeScrollbars = false) const;
147     virtual void setFixedVisibleContentRect(const IntRect& visibleContentRect) { m_fixedVisibleContentRect = visibleContentRect; }
148     IntRect fixedVisibleContentRect() const { return m_fixedVisibleContentRect; }
149     int visibleWidth() const { return visibleContentRect().width(); }
150     int visibleHeight() const { return visibleContentRect().height(); }
151
152     // Functions for getting/setting the size webkit should use to layout the contents. By default this is the same as the visible
153     // content size. Explicitly setting a layout size value will cause webkit to layout the contents using this size instead.
154     int layoutWidth() const;
155     int layoutHeight() const;
156     IntSize fixedLayoutSize() const;
157     void setFixedLayoutSize(const IntSize&);
158     bool useFixedLayout() const;
159     void setUseFixedLayout(bool enable);
160     
161     // Functions for getting/setting the size of the document contained inside the ScrollView (as an IntSize or as individual width and height
162     // values).
163     IntSize contentsSize() const; // Always at least as big as the visibleWidth()/visibleHeight().
164     int contentsWidth() const { return contentsSize().width(); }
165     int contentsHeight() const { return contentsSize().height(); }
166     virtual void setContentsSize(const IntSize&);
167
168     // Functions for querying the current scrolled position (both as a point, a size, or as individual X and Y values).
169     IntPoint scrollPosition() const { return visibleContentRect().location(); }
170     IntSize scrollOffset() const { return visibleContentRect().location() - IntPoint(); } // Gets the scrolled position as an IntSize. Convenient for adding to other sizes.
171     IntPoint maximumScrollPosition() const; // The maximum position we can be scrolled to.
172     IntPoint minimumScrollPosition() const; // The minimum position we can be scrolled to.
173     // Adjust the passed in scroll position to keep it between the minimum and maximum positions.
174     IntPoint adjustScrollPositionWithinRange(const IntPoint&) const; 
175     int scrollX() const { return scrollPosition().x(); }
176     int scrollY() const { return scrollPosition().y(); }
177
178     IntSize overhangAmount() const;
179
180     void cacheCurrentScrollPosition() { m_cachedScrollPosition = scrollPosition(); }
181     IntPoint cachedScrollPosition() const { return m_cachedScrollPosition; }
182
183     // Functions for scrolling the view.
184     void setScrollPosition(const IntPoint&);
185     void scrollBy(const IntSize& s) { return setScrollPosition(scrollPosition() + s); }
186
187     // This function scrolls by lines, pages or pixels.
188     bool scroll(ScrollDirection, ScrollGranularity);
189     
190     // A logical scroll that just ends up calling the corresponding physical scroll() based off the document's writing mode.
191     bool logicalScroll(ScrollLogicalDirection, ScrollGranularity);
192
193     // Scroll the actual contents of the view (either blitting or invalidating as needed).
194     void scrollContents(const IntSize& scrollDelta);
195
196     // This gives us a means of blocking painting on our scrollbars until the first layout has occurred.
197     void setScrollbarsSuppressed(bool suppressed, bool repaintOnUnsuppress = false);
198     bool scrollbarsSuppressed() const { return m_scrollbarsSuppressed; }
199
200     IntPoint rootViewToContents(const IntPoint&) const;
201     IntPoint contentsToRootView(const IntPoint&) const;
202     IntRect rootViewToContents(const IntRect&) const;
203     IntRect contentsToRootView(const IntRect&) const;
204
205     // Event coordinates are assumed to be in the coordinate space of a window that contains
206     // the entire widget hierarchy. It is up to the platform to decide what the precise definition
207     // of containing window is. (For example on Mac it is the containing NSWindow.)
208     IntPoint windowToContents(const IntPoint&) const;
209     IntPoint contentsToWindow(const IntPoint&) const;
210     IntRect windowToContents(const IntRect&) const;
211     IntRect contentsToWindow(const IntRect&) const;
212
213     // Functions for converting to and from screen coordinates.
214     IntRect contentsToScreen(const IntRect&) const;
215     IntPoint screenToContents(const IntPoint&) const;
216
217     // 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
218     // we know that we are either not in a window right now or if that window is not visible.
219     bool isOffscreen() const;
220     
221     // These functions are used to enable scrollbars to avoid window resizer controls that overlap the scroll view. This happens on Mac
222     // for example.
223     virtual IntRect windowResizerRect() const { return IntRect(); }
224     bool containsScrollbarsAvoidingResizer() const;
225     void adjustScrollbarsAvoidingResizerCount(int overlapDelta);
226     void windowResizerRectChanged();
227
228     virtual void setParent(ScrollView*); // Overridden to update the overlapping scrollbar count.
229
230     // Called when our frame rect changes (or the rect/scroll position of an ancestor changes).
231     virtual void frameRectsChanged();
232     
233     // Widget override to update our scrollbars and notify our contents of the resize.
234     virtual void setFrameRect(const IntRect&);
235
236     // For platforms that need to hit test scrollbars from within the engine's event handlers (like Win32).
237     Scrollbar* scrollbarAtPoint(const IntPoint& windowPoint);
238
239     IntPoint convertChildToSelf(const Widget* child, const IntPoint& point) const
240     {
241         IntPoint newPoint = point;
242         if (!isScrollViewScrollbar(child))
243             newPoint = point - scrollOffset();
244         newPoint.moveBy(child->location());
245         return newPoint;
246     }
247
248     IntPoint convertSelfToChild(const Widget* child, const IntPoint& point) const
249     {
250         IntPoint newPoint = point;
251         if (!isScrollViewScrollbar(child))
252             newPoint = point + scrollOffset();
253         newPoint.moveBy(-child->location());
254         return newPoint;
255     }
256
257     // Widget override. Handles painting of the contents of the view as well as the scrollbars.
258     virtual void paint(GraphicsContext*, const IntRect&);
259     void paintScrollbars(GraphicsContext*, const IntRect&);
260
261     // Widget overrides to ensure that our children's visibility status is kept up to date when we get shown and hidden.
262     virtual void show();
263     virtual void hide();
264     virtual void setParentVisible(bool);
265     
266     // Pan scrolling.
267     static const int noPanScrollRadius = 15;
268     void addPanScrollIcon(const IntPoint&);
269     void removePanScrollIcon();
270     void paintPanScrollIcon(GraphicsContext*);
271
272     virtual bool isPointInScrollbarCorner(const IntPoint&);
273     virtual bool scrollbarCornerPresent() const;
274     virtual IntRect scrollCornerRect() const;
275     virtual void paintScrollCorner(GraphicsContext*, const IntRect& cornerRect);
276     virtual void paintScrollbar(GraphicsContext*, Scrollbar*, const IntRect&);
277
278     virtual IntRect convertFromScrollbarToContainingView(const Scrollbar*, const IntRect&) const;
279     virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar*, const IntRect&) const;
280     virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar*, const IntPoint&) const;
281     virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar*, const IntPoint&) const;
282
283     bool containsScrollableAreaWithOverlayScrollbars() const { return m_containsScrollableAreaWithOverlayScrollbars; }
284     void setContainsScrollableAreaWithOverlayScrollbars(bool contains) { m_containsScrollableAreaWithOverlayScrollbars = contains; }
285
286     void calculateAndPaintOverhangAreas(GraphicsContext*, const IntRect& dirtyRect);
287
288 protected:
289     ScrollView();
290
291     virtual void repaintContentRectangle(const IntRect&, bool now = false);
292     virtual void paintContents(GraphicsContext*, const IntRect& damageRect) = 0;
293
294     virtual void paintOverhangAreas(GraphicsContext*, const IntRect& horizontalOverhangArea, const IntRect& verticalOverhangArea, const IntRect& dirtyRect);
295
296     virtual void visibleContentsResized() = 0;
297     virtual void delegatesScrollingDidChange() { }
298     // These functions are used to create/destroy scrollbars.
299     void setHasHorizontalScrollbar(bool);
300     void setHasVerticalScrollbar(bool);
301
302     virtual void updateScrollCorner();
303     virtual void invalidateScrollCornerRect(const IntRect&);
304
305     // Scroll the content by blitting the pixels.
306     virtual bool scrollContentsFastPath(const IntSize& scrollDelta, const IntRect& rectToScroll, const IntRect& clipRect);
307     // Scroll the content by invalidating everything.
308     virtual void scrollContentsSlowPath(const IntRect& updateRect);
309
310     void setScrollOrigin(const IntPoint&, bool updatePositionAtAll, bool updatePositionSynchronously);
311
312     // Subclassed by FrameView to check the writing-mode of the document.
313     virtual bool isVerticalDocument() const { return true; }
314     virtual bool isFlippedDocument() const { return false; }
315
316 private:
317     RefPtr<Scrollbar> m_horizontalScrollbar;
318     RefPtr<Scrollbar> m_verticalScrollbar;
319     ScrollbarMode m_horizontalScrollbarMode;
320     ScrollbarMode m_verticalScrollbarMode;
321
322     bool m_horizontalScrollbarLock;
323     bool m_verticalScrollbarLock;
324
325     bool m_prohibitsScrolling;
326
327     HashSet<RefPtr<Widget> > m_children;
328
329     // This bool is unused on Mac OS because we directly ask the platform widget
330     // whether it is safe to blit on scroll.
331     bool m_canBlitOnScroll;
332
333     IntRect m_fixedVisibleContentRect;
334     IntSize m_scrollOffset; // FIXME: Would rather store this as a position, but we will wait to make this change until more code is shared.
335     IntPoint m_cachedScrollPosition;
336     IntSize m_fixedLayoutSize;
337     IntSize m_contentsSize;
338
339     int m_scrollbarsAvoidingResizer;
340     bool m_scrollbarsSuppressed;
341
342     bool m_inUpdateScrollbars;
343     unsigned m_updateScrollbarsPass;
344
345     IntPoint m_panScrollIconPoint;
346     bool m_drawPanScrollIcon;
347     bool m_useFixedLayout;
348
349     bool m_paintsEntireContents;
350     bool m_clipsRepaints;
351     bool m_delegatesScrolling;
352
353     bool m_containsScrollableAreaWithOverlayScrollbars;
354
355     void init();
356     void destroy();
357
358     // Called to update the scrollbars to accurately reflect the state of the view.
359     void updateScrollbars(const IntSize& desiredOffset);
360     IntRect rectToCopyOnScroll() const;
361
362     // Called when the scroll position within this view changes.  FrameView overrides this to generate repaint invalidations.
363     virtual void repaintFixedElementsAfterScrolling() { }
364     virtual void updateFixedElementsAfterScrolling() { }
365
366     void platformInit();
367     void platformDestroy();
368     void platformAddChild(Widget*);
369     void platformRemoveChild(Widget*);
370     void platformSetScrollbarModes();
371     void platformScrollbarModes(ScrollbarMode& horizontal, ScrollbarMode& vertical) const;
372     void platformSetCanBlitOnScroll(bool);
373     bool platformCanBlitOnScroll() const;
374     IntRect platformVisibleContentRect(bool includeScrollbars) const;
375     void platformSetContentsSize();
376     IntRect platformContentsToScreen(const IntRect&) const;
377     IntPoint platformScreenToContents(const IntPoint&) const;
378     void platformSetScrollPosition(const IntPoint&);
379     bool platformScroll(ScrollDirection, ScrollGranularity);
380     void platformSetScrollbarsSuppressed(bool repaintOnUnsuppress);
381     void platformRepaintContentRectangle(const IntRect&, bool now);
382     bool platformIsOffscreen() const;
383     void platformSetScrollbarOverlayStyle(ScrollbarOverlayStyle);
384    
385     void platformSetScrollOrigin(const IntPoint&, bool updatePositionAtAll, bool updatePositionSynchronously);
386
387     void calculateOverhangAreasForPainting(IntRect& horizontalOverhangRect, IntRect& verticalOverhangRect);
388     void updateOverhangAreas();
389
390 #if PLATFORM(MAC) && defined __OBJC__
391 public:
392     NSView* documentView() const;
393
394 private:
395     NSScrollView<WebCoreFrameScrollView>* scrollView() const;
396 #endif
397
398 #if PLATFORM(WX)
399 public:
400     virtual void setPlatformWidget(wxWindow*);
401     void adjustScrollbars(int x = -1, int y = -1, bool refresh = true);
402 private:
403     class ScrollViewPrivate;
404     ScrollViewPrivate* m_data;
405 #endif
406
407 }; // class ScrollView
408
409 } // namespace WebCore
410
411 #endif // ScrollView_h