2 * Copyright (C) 2004, 2006, 2007, 2008 Apple Inc. All rights reserved.
3 * Copyright (C) 2009 Holger Hans Peter Freyther
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
31 #include "Scrollbar.h"
32 #include "ScrollableArea.h"
33 #include "ScrollTypes.h"
36 #include <wtf/HashSet.h>
38 #if PLATFORM(MAC) && defined __OBJC__
39 @protocol WebCoreFrameScrollView;
43 class wxScrollWinEvent;
51 class ScrollView : public Widget, public ScrollableArea {
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();
64 // NOTE: This should only be called by the overriden setScrollOffset from ScrollableArea.
65 virtual void scrollTo(const IntSize& newOffset);
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;
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;
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*);
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; }
85 void positionScrollbarLayers();
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; }
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; }
104 void setScrollingModesLock(bool lock = true) { m_horizontalScrollbarLock = m_verticalScrollbarLock = lock; }
106 virtual void setCanHaveScrollbars(bool);
107 bool canHaveScrollbars() const { return horizontalScrollbarMode() != ScrollbarAlwaysOff || verticalScrollbarMode() != ScrollbarAlwaysOff; }
109 virtual bool avoidScrollbarCreation() const { return false; }
111 virtual void setScrollbarOverlayStyle(ScrollbarOverlayStyle);
113 // By default you only receive paint events for the area that is visible. In the case of using a
114 // tiled backing store, this function can be set, so that the view paints the entire contents.
115 bool paintsEntireContents() const { return m_paintsEntireContents; }
116 void setPaintsEntireContents(bool);
118 // By default, paint events are clipped to the visible area. If set to
119 // false, paint events are no longer clipped. paintsEntireContents() implies !clipsRepaints().
120 bool clipsRepaints() const { return m_clipsRepaints; }
121 void setClipsRepaints(bool);
123 // By default programmatic scrolling is handled by WebCore and not by the UI application.
124 // In the case of using a tiled backing store, this mode can be set, so that the scroll requests
125 // are delegated to the UI application.
126 bool delegatesScrolling() const { return m_delegatesScrolling; }
127 void setDelegatesScrolling(bool);
129 // Overridden by FrameView to create custom CSS scrollbars if applicable.
130 virtual PassRefPtr<Scrollbar> createScrollbar(ScrollbarOrientation);
132 // If the prohibits scrolling flag is set, then all scrolling in the view (even programmatic scrolling) is turned off.
133 void setProhibitsScrolling(bool b) { m_prohibitsScrolling = b; }
134 bool prohibitsScrolling() const { return m_prohibitsScrolling; }
136 // Whether or not a scroll view will blit visible contents when it is scrolled. Blitting is disabled in situations
137 // where it would cause rendering glitches (such as with fixed backgrounds or when the view is partially transparent).
138 void setCanBlitOnScroll(bool);
139 bool canBlitOnScroll() const;
141 // The visible content rect has a location that is the scrolled offset of the document. The width and height are the viewport width
142 // and height. By default the scrollbars themselves are excluded from this rectangle, but an optional boolean argument allows them to be
144 // In the situation the client is responsible for the scrolling (ie. with a tiled backing store) it is possible to use
145 // the setFixedVisibleContentRect instead for the mainframe, though this must be updated manually, e.g just before resuming the page
146 // which usually will happen when panning, pinching and rotation ends, or when scale or position are changed manually.
147 virtual IntRect visibleContentRect(bool includeScrollbars = false) const;
148 void setFixedVisibleContentRect(const IntRect& visibleContentRect) { m_fixedVisibleContentRect = visibleContentRect; }
149 LayoutUnit visibleWidth() const { return visibleContentRect().width(); }
150 LayoutUnit visibleHeight() const { return visibleContentRect().height(); }
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);
161 // Functions for getting/setting the size of the document contained inside the ScrollView (as an IntSize or as individual width and height
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&);
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(); }
178 IntSize overhangAmount() const;
180 void cacheCurrentScrollPosition() { m_cachedScrollPosition = scrollPosition(); }
181 IntPoint cachedScrollPosition() const { return m_cachedScrollPosition; }
183 // Functions for scrolling the view.
184 void setScrollPosition(const IntPoint&);
185 void scrollBy(const IntSize& s) { return setScrollPosition(scrollPosition() + s); }
187 // This function scrolls by lines, pages or pixels.
188 bool scroll(ScrollDirection, ScrollGranularity);
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);
193 // Scroll the actual contents of the view (either blitting or invalidating as needed).
194 void scrollContents(const IntSize& scrollDelta);
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; }
200 // Event coordinates are assumed to be in the coordinate space of a window that contains
201 // the entire widget hierarchy. It is up to the platform to decide what the precise definition
202 // of containing window is. (For example on Mac it is the containing NSWindow.)
203 IntPoint windowToContents(const IntPoint&) const;
204 IntPoint contentsToWindow(const IntPoint&) const;
205 IntRect windowToContents(const IntRect&) const;
206 IntRect contentsToWindow(const IntRect&) const;
208 // Functions for converting to and from screen coordinates.
209 IntRect contentsToScreen(const IntRect&) const;
210 IntPoint screenToContents(const IntPoint&) const;
212 // 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
213 // we know that we are either not in a window right now or if that window is not visible.
214 bool isOffscreen() const;
216 // These functions are used to enable scrollbars to avoid window resizer controls that overlap the scroll view. This happens on Mac
218 virtual IntRect windowResizerRect() const { return IntRect(); }
219 bool containsScrollbarsAvoidingResizer() const;
220 void adjustScrollbarsAvoidingResizerCount(int overlapDelta);
221 void windowResizerRectChanged();
223 virtual void setParent(ScrollView*); // Overridden to update the overlapping scrollbar count.
225 // Called when our frame rect changes (or the rect/scroll position of an ancestor changes).
226 virtual void frameRectsChanged();
228 // Widget override to update our scrollbars and notify our contents of the resize.
229 virtual void setFrameRect(const IntRect&);
230 virtual void setBoundsSize(const IntSize&);
232 // For platforms that need to hit test scrollbars from within the engine's event handlers (like Win32).
233 Scrollbar* scrollbarAtPoint(const IntPoint& windowPoint);
235 // This function exists for scrollviews that need to handle wheel events manually.
236 // On Mac the underlying NSScrollView just does the scrolling, but on other platforms
237 // (like Windows), we need this function in order to do the scroll ourselves.
238 void wheelEvent(PlatformWheelEvent&);
239 #if ENABLE(GESTURE_EVENTS)
240 void gestureEvent(const PlatformGestureEvent&);
243 IntPoint convertChildToSelf(const Widget* child, const IntPoint& point) const
245 IntPoint newPoint = point;
246 if (!isScrollViewScrollbar(child))
247 newPoint = point - scrollOffset();
248 newPoint.moveBy(child->location());
252 IntPoint convertSelfToChild(const Widget* child, const IntPoint& point) const
254 IntPoint newPoint = point;
255 if (!isScrollViewScrollbar(child))
256 newPoint = point + scrollOffset();
257 newPoint.moveBy(-child->location());
261 // Widget override. Handles painting of the contents of the view as well as the scrollbars.
262 virtual void paint(GraphicsContext*, const IntRect&);
263 void paintScrollbars(GraphicsContext*, const IntRect&);
265 // Widget overrides to ensure that our children's visibility status is kept up to date when we get shown and hidden.
268 virtual void setParentVisible(bool);
271 static const int noPanScrollRadius = 15;
272 void addPanScrollIcon(const IntPoint&);
273 void removePanScrollIcon();
274 void paintPanScrollIcon(GraphicsContext*);
276 virtual bool isPointInScrollbarCorner(const IntPoint&);
277 virtual bool scrollbarCornerPresent() const;
278 virtual IntRect scrollCornerRect() const;
279 virtual void paintScrollCorner(GraphicsContext*, const IntRect& cornerRect);
281 virtual IntRect convertFromScrollbarToContainingView(const Scrollbar*, const IntRect&) const;
282 virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar*, const IntRect&) const;
283 virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar*, const IntPoint&) const;
284 virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar*, const IntPoint&) const;
286 bool containsScrollableAreaWithOverlayScrollbars() const { return m_containsScrollableAreaWithOverlayScrollbars; }
287 void setContainsScrollableAreaWithOverlayScrollbars(bool contains) { m_containsScrollableAreaWithOverlayScrollbars = contains; }
289 void calculateAndPaintOverhangAreas(GraphicsContext*, const IntRect& dirtyRect);
294 virtual void repaintContentRectangle(const IntRect&, bool now = false);
295 virtual void paintContents(GraphicsContext*, const IntRect& damageRect) = 0;
297 void calculateOverhangAreasForPainting(IntRect& horizontalOverhangRect, IntRect& verticalOverhangRect);
298 virtual void paintOverhangAreas(GraphicsContext*, const IntRect& horizontalOverhangArea, const IntRect& verticalOverhangArea, const IntRect& dirtyRect);
300 virtual void contentsResized() = 0;
301 virtual void visibleContentsResized() = 0;
303 IntRect fixedVisibleContentRect() const { return m_fixedVisibleContentRect; }
305 IntSize boundsSize() const { return m_boundsSize; }
306 void setInitialBoundsSize(const IntSize&);
308 // These functions are used to create/destroy scrollbars.
309 void setHasHorizontalScrollbar(bool);
310 void setHasVerticalScrollbar(bool);
312 virtual void updateScrollCorner();
313 virtual void invalidateScrollCornerRect(const IntRect&);
315 // Scroll the content by blitting the pixels.
316 virtual bool scrollContentsFastPath(const IntSize& scrollDelta, const IntRect& rectToScroll, const IntRect& clipRect);
317 // Scroll the content by invalidating everything.
318 virtual void scrollContentsSlowPath(const IntRect& updateRect);
320 void setScrollOrigin(const IntPoint&, bool updatePositionAtAll, bool updatePositionSynchronously);
321 IntPoint scrollOrigin() const { return m_scrollOrigin; }
323 // Subclassed by FrameView to check the writing-mode of the document.
324 virtual bool isVerticalDocument() const { return true; }
325 virtual bool isFlippedDocument() const { return false; }
328 RefPtr<Scrollbar> m_horizontalScrollbar;
329 RefPtr<Scrollbar> m_verticalScrollbar;
330 ScrollbarMode m_horizontalScrollbarMode;
331 ScrollbarMode m_verticalScrollbarMode;
333 bool m_horizontalScrollbarLock;
334 bool m_verticalScrollbarLock;
336 bool m_prohibitsScrolling;
338 HashSet<RefPtr<Widget> > m_children;
340 // This bool is unused on Mac OS because we directly ask the platform widget
341 // whether it is safe to blit on scroll.
342 bool m_canBlitOnScroll;
344 IntRect m_fixedVisibleContentRect;
345 IntSize m_scrollOffset; // FIXME: Would rather store this as a position, but we will wait to make this change until more code is shared.
346 IntPoint m_cachedScrollPosition;
347 IntSize m_fixedLayoutSize;
348 IntSize m_contentsSize;
350 int m_scrollbarsAvoidingResizer;
351 bool m_scrollbarsSuppressed;
353 bool m_inUpdateScrollbars;
354 unsigned m_updateScrollbarsPass;
356 IntPoint m_panScrollIconPoint;
357 bool m_drawPanScrollIcon;
358 bool m_useFixedLayout;
360 bool m_paintsEntireContents;
361 bool m_clipsRepaints;
362 bool m_delegatesScrolling;
364 bool m_containsScrollableAreaWithOverlayScrollbars;
366 IntSize m_boundsSize;
371 // Called to update the scrollbars to accurately reflect the state of the view.
372 void updateScrollbars(const IntSize& desiredOffset);
373 IntRect rectToCopyOnScroll() const;
375 // Called when the scroll position within this view changes. FrameView overrides this to generate repaint invalidations.
376 virtual void repaintFixedElementsAfterScrolling() {}
379 void platformDestroy();
380 void platformAddChild(Widget*);
381 void platformRemoveChild(Widget*);
382 void platformSetScrollbarModes();
383 void platformScrollbarModes(ScrollbarMode& horizontal, ScrollbarMode& vertical) const;
384 void platformSetCanBlitOnScroll(bool);
385 bool platformCanBlitOnScroll() const;
386 IntRect platformVisibleContentRect(bool includeScrollbars) const;
387 IntSize platformContentsSize() const;
388 void platformSetContentsSize();
389 IntRect platformContentsToScreen(const IntRect&) const;
390 IntPoint platformScreenToContents(const IntPoint&) const;
391 void platformSetScrollPosition(const IntPoint&);
392 bool platformScroll(ScrollDirection, ScrollGranularity);
393 void platformSetScrollbarsSuppressed(bool repaintOnUnsuppress);
394 void platformRepaintContentRectangle(const IntRect&, bool now);
395 bool platformIsOffscreen() const;
396 void platformSetScrollbarOverlayStyle(ScrollbarOverlayStyle);
398 void platformSetScrollOrigin(const IntPoint&, bool updatePositionAtAll, bool updatePositionSynchronously);
400 #if PLATFORM(MAC) && defined __OBJC__
402 NSView* documentView() const;
405 NSScrollView<WebCoreFrameScrollView>* scrollView() const;
410 virtual void setPlatformWidget(wxWindow*);
411 void adjustScrollbars(int x = -1, int y = -1, bool refresh = true);
413 class ScrollViewPrivate;
414 ScrollViewPrivate* m_data;
417 }; // class ScrollView
419 } // namespace WebCore
421 #endif // ScrollView_h