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