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