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