Revert use of SVG <mask> elements for -webkit-mask-image (r176798, r177494, r186180)
[WebKit-https.git] / Source / WebCore / platform / ScrollView.h
1 /*
2  * Copyright (C) 2004, 2006, 2007, 2008, 2013, 2014 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 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 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 "FloatRect.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(IOS)
40 #ifdef __OBJC__
41 @class WAKScrollView;
42 @class WAKView;
43 #else
44 class WAKScrollView;
45 class WAKView;
46 #endif
47
48 #ifndef NSScrollView
49 #define NSScrollView WAKScrollView
50 #endif
51
52 #ifndef NSView
53 #define NSView WAKView
54 #endif
55 #endif // PLATFORM(IOS)
56
57 #if PLATFORM(COCOA) && defined __OBJC__
58 @protocol WebCoreFrameScrollView;
59 #endif
60
61 namespace WebCore {
62
63 class HostWindow;
64 class LegacyTileCache;
65 class Scrollbar;
66
67 class ScrollView : public Widget, public ScrollableArea {
68 public:
69     virtual ~ScrollView();
70
71     // ScrollableArea functions.
72     virtual int scrollSize(ScrollbarOrientation) const override;
73     virtual int scrollPosition(Scrollbar*) const override;
74     WEBCORE_EXPORT virtual void setScrollOffset(const IntPoint&) override;
75     virtual bool isScrollCornerVisible() const override;
76     virtual void scrollbarStyleChanged(ScrollbarStyle, bool forceUpdate) override;
77
78     virtual void notifyPageThatContentAreaWillPaint() const;
79
80     // NOTE: This should only be called by the overriden setScrollOffset from ScrollableArea.
81     virtual void scrollTo(const IntSize& newOffset);
82
83     // The window thats hosts the ScrollView. The ScrollView will communicate scrolls and repaints to the
84     // host window in the window's coordinate space.
85     virtual HostWindow* hostWindow() const = 0;
86
87     // Returns a clip rect in host window coordinates. Used to clip the blit on a scroll.
88     virtual IntRect windowClipRect() const = 0;
89
90     // Functions for child manipulation and inspection.
91     const HashSet<RefPtr<Widget>>& children() const { return m_children; }
92     WEBCORE_EXPORT virtual void addChild(PassRefPtr<Widget>);
93     virtual void removeChild(Widget&);
94
95     // If the scroll view does not use a native widget, then it will have cross-platform Scrollbars. These functions
96     // can be used to obtain those scrollbars.
97     virtual Scrollbar* horizontalScrollbar() const override { return m_horizontalScrollbar.get(); }
98     virtual Scrollbar* verticalScrollbar() const override { return m_verticalScrollbar.get(); }
99     bool isScrollViewScrollbar(const Widget* child) const { return horizontalScrollbar() == child || verticalScrollbar() == child; }
100
101     void positionScrollbarLayers();
102
103     // Functions for setting and retrieving the scrolling mode in each axis (horizontal/vertical). The mode has values of
104     // AlwaysOff, AlwaysOn, and Auto. AlwaysOff means never show a scrollbar, AlwaysOn means always show a scrollbar.
105     // Auto means show a scrollbar only when one is needed.
106     // Note that for platforms with native widgets, these modes are considered advisory. In other words the underlying native
107     // widget may choose not to honor the requested modes.
108     void setScrollbarModes(ScrollbarMode horizontalMode, ScrollbarMode verticalMode, bool horizontalLock = false, bool verticalLock = false);
109     void setHorizontalScrollbarMode(ScrollbarMode mode, bool lock = false) { setScrollbarModes(mode, verticalScrollbarMode(), lock, verticalScrollbarLock()); }
110     void setVerticalScrollbarMode(ScrollbarMode mode, bool lock = false) { setScrollbarModes(horizontalScrollbarMode(), mode, horizontalScrollbarLock(), lock); };
111     WEBCORE_EXPORT void scrollbarModes(ScrollbarMode& horizontalMode, ScrollbarMode& verticalMode) const;
112     ScrollbarMode horizontalScrollbarMode() const { ScrollbarMode horizontal, vertical; scrollbarModes(horizontal, vertical); return horizontal; }
113     ScrollbarMode verticalScrollbarMode() const { ScrollbarMode horizontal, vertical; scrollbarModes(horizontal, vertical); return vertical; }
114
115     void setHorizontalScrollbarLock(bool lock = true) { m_horizontalScrollbarLock = lock; }
116     bool horizontalScrollbarLock() const { return m_horizontalScrollbarLock; }
117     void setVerticalScrollbarLock(bool lock = true) { m_verticalScrollbarLock = lock; }
118     bool verticalScrollbarLock() const { return m_verticalScrollbarLock; }
119
120     void setScrollingModesLock(bool lock = true) { m_horizontalScrollbarLock = m_verticalScrollbarLock = lock; }
121
122     WEBCORE_EXPORT virtual void setCanHaveScrollbars(bool);
123     bool canHaveScrollbars() const { return horizontalScrollbarMode() != ScrollbarAlwaysOff || verticalScrollbarMode() != ScrollbarAlwaysOff; }
124
125     virtual bool avoidScrollbarCreation() const { return false; }
126
127     virtual void setScrollbarOverlayStyle(ScrollbarOverlayStyle) override;
128
129     // By default you only receive paint events for the area that is visible. In the case of using a
130     // tiled backing store, this function can be set, so that the view paints the entire contents.
131     bool paintsEntireContents() const { return m_paintsEntireContents; }
132     WEBCORE_EXPORT void setPaintsEntireContents(bool);
133
134     // By default, paint events are clipped to the visible area.  If set to
135     // false, paint events are no longer clipped.  paintsEntireContents() implies !clipsRepaints().
136     bool clipsRepaints() const { return m_clipsRepaints; }
137     void setClipsRepaints(bool);
138
139     // By default programmatic scrolling is handled by WebCore and not by the UI application.
140     // In the case of using a tiled backing store, this mode can be set, so that the scroll requests
141     // are delegated to the UI application.
142     bool delegatesScrolling() const { return m_delegatesScrolling; }
143     WEBCORE_EXPORT void setDelegatesScrolling(bool);
144
145     // Overridden by FrameView to create custom CSS scrollbars if applicable.
146     virtual PassRefPtr<Scrollbar> createScrollbar(ScrollbarOrientation);
147
148     void styleDidChange();
149
150     // If the prohibits scrolling flag is set, then all scrolling in the view (even programmatic scrolling) is turned off.
151     void setProhibitsScrolling(bool b) { m_prohibitsScrolling = b; }
152     bool prohibitsScrolling() const { return m_prohibitsScrolling; }
153
154     // Whether or not a scroll view will blit visible contents when it is scrolled. Blitting is disabled in situations
155     // where it would cause rendering glitches (such as with fixed backgrounds or when the view is partially transparent).
156     void setCanBlitOnScroll(bool);
157     bool canBlitOnScroll() const;
158
159     // There are at least three types of contentInset. Usually we just care about WebCoreContentInset, which is the inset
160     // that is set on a Page that requires WebCore to move its layers to accomodate the inset. However, there are platform
161     // concepts that are similar on both iOS and Mac when there is a platformWidget(). Sometimes we need the Mac platform value
162     // for topContentInset, so when the TopContentInsetType is WebCoreOrPlatformContentInset, platformTopContentInset()
163     // will be returned instead of the value set on Page.
164     enum class TopContentInsetType { WebCoreContentInset, WebCoreOrPlatformContentInset };
165     virtual float topContentInset(TopContentInsetType = TopContentInsetType::WebCoreContentInset) const { return 0; }
166
167     // The visible content rect has a location that is the scrolled offset of the document. The width and height are the unobscured viewport
168     // width and height. By default the scrollbars themselves are excluded from this rectangle, but an optional boolean argument allows them
169     // to be included.
170     // In the situation the client is responsible for the scrolling (ie. with a tiled backing store) it is possible to use
171     // the setFixedVisibleContentRect instead for the mainframe, though this must be updated manually, e.g just before resuming the page
172     // which usually will happen when panning, pinching and rotation ends, or when scale or position are changed manually.
173     virtual IntSize visibleSize() const override { return visibleContentRect(LegacyIOSDocumentVisibleRect).size(); }
174
175 #if USE(COORDINATED_GRAPHICS)
176     virtual void setFixedVisibleContentRect(const IntRect& visibleContentRect) { m_fixedVisibleContentRect = visibleContentRect; }
177     IntRect fixedVisibleContentRect() const { return m_fixedVisibleContentRect; }
178 #endif
179
180     // Parts of the document can be visible through transparent or blured UI widgets of the chrome. Those parts
181     // contribute to painting but not to the scrollable area.
182     // The unobscuredContentRect is the area that is not covered by UI elements.
183     WEBCORE_EXPORT IntRect unobscuredContentRect(VisibleContentRectIncludesScrollbars = ExcludeScrollbars) const;
184 #if PLATFORM(IOS)
185     IntRect unobscuredContentRectIncludingScrollbars() const { return unobscuredContentRect(IncludeScrollbars); }
186 #else
187     IntRect unobscuredContentRectIncludingScrollbars() const { return visibleContentRectIncludingScrollbars(); }
188 #endif
189
190 #if PLATFORM(IOS)
191     // This is the area that is partially or fully exposed, and may extend under overlapping UI elements.
192     WEBCORE_EXPORT FloatRect exposedContentRect() const;
193
194     // The given rects are only used if there is no platform widget.
195     WEBCORE_EXPORT void setExposedContentRect(const FloatRect&);
196     const FloatSize& unobscuredContentSize() const { return m_unobscuredContentSize; }
197     WEBCORE_EXPORT void setUnobscuredContentSize(const FloatSize&);
198
199     void setActualScrollPosition(const IntPoint&);
200     LegacyTileCache* legacyTileCache();
201 #endif
202
203     virtual bool inProgrammaticScroll() const { return false; }
204
205     // visibleContentRect().size() is computed from unscaledUnobscuredVisibleContentSize() divided by the value of visibleContentScaleFactor.
206     // visibleContentScaleFactor is usually 1, except when the setting delegatesPageScaling is true and the
207     // ScrollView is the main frame; in that case, visibleContentScaleFactor is equal to the page's pageScaleFactor.
208     // Ports that don't use pageScaleFactor can treat unscaledUnobscuredVisibleContentSize and visibleContentRect().size() as equivalent.
209     // unscaledVisibleContentSizeIncludingObscuredArea() includes areas in the content that might be obscured by UI elements.
210     IntSize unscaledUnobscuredVisibleContentSize(VisibleContentRectIncludesScrollbars = ExcludeScrollbars) const;
211     IntSize unscaledVisibleContentSizeIncludingObscuredArea(VisibleContentRectIncludesScrollbars = ExcludeScrollbars) const;
212     virtual float visibleContentScaleFactor() const { return 1; }
213
214     // Functions for getting/setting the size webkit should use to layout the contents. By default this is the same as the visible
215     // content size. Explicitly setting a layout size value will cause webkit to layout the contents using this size instead.
216     IntSize layoutSize() const;
217     int layoutWidth() const { return layoutSize().width(); }
218     int layoutHeight() const { return layoutSize().height(); }
219     WEBCORE_EXPORT IntSize fixedLayoutSize() const;
220     WEBCORE_EXPORT void setFixedLayoutSize(const IntSize&);
221     WEBCORE_EXPORT bool useFixedLayout() const;
222     WEBCORE_EXPORT void setUseFixedLayout(bool enable);
223
224     // Functions for getting/setting the size of the document contained inside the ScrollView (as an IntSize or as individual width and height
225     // values).
226     WEBCORE_EXPORT virtual IntSize contentsSize() const override; // Always at least as big as the visibleWidth()/visibleHeight().
227     int contentsWidth() const { return contentsSize().width(); }
228     int contentsHeight() const { return contentsSize().height(); }
229     virtual void setContentsSize(const IntSize&);
230
231     // Functions for querying the current scrolled position (both as a point, a size, or as individual X and Y values).
232     virtual IntPoint scrollPosition() const override { return visibleContentRect(LegacyIOSDocumentVisibleRect).location(); }
233     IntSize scrollOffset() const { return toIntSize(visibleContentRect(LegacyIOSDocumentVisibleRect).location()); } // Gets the scrolled position as an IntSize. Convenient for adding to other sizes.
234     virtual IntPoint maximumScrollPosition() const override; // The maximum position we can be scrolled to.
235     virtual IntPoint minimumScrollPosition() const override; // The minimum position we can be scrolled to.
236     // Adjust the passed in scroll position to keep it between the minimum and maximum positions.
237     IntPoint adjustScrollPositionWithinRange(const IntPoint&) const; 
238     int scrollX() const { return scrollPosition().x(); }
239     int scrollY() const { return scrollPosition().y(); }
240
241     // Scroll position used by web-exposed features (has legacy iOS behavior).
242     IntPoint contentsScrollPosition() const;
243     void setContentsScrollPosition(const IntPoint&);
244
245 #if PLATFORM(IOS)
246     int actualScrollX() const { return unobscuredContentRect().x(); }
247     int actualScrollY() const { return unobscuredContentRect().y(); }
248     // FIXME: maybe fix scrollPosition() on iOS to return the actual scroll position.
249     IntPoint actualScrollPosition() const { return unobscuredContentRect().location(); }
250 #endif
251
252     // scrollOffset() anchors its (0,0) point at the ScrollableArea's origin. When the Page has a
253     // header, the header is positioned at (0,0), ABOVE the start of the Document. So when a page with
254     // a header is pinned to the top, the scrollOffset() is (0,0), but the Document is actually at
255     // (0, -headerHeight()). documentScrollOffsetRelativeToScrollableAreaOrigin() will return this
256     // version of the offset, which tracks the top of Document relative to where scrolling was achored.
257     IntSize documentScrollOffsetRelativeToScrollableAreaOrigin() const;
258
259     // scrollOffset() anchors its (0,0) point at the ScrollableArea's origin. The top of the scrolling
260     // layer does not represent the top of the view when there is a topContentInset. Additionally, as
261     // detailed above, the origin of the scrolling layer also does not necessarily correspond with the
262     // top of the document anyway, since there could also be header. documentScrollOffsetRelativeToViewOrigin()
263     // will return a version of the current scroll offset which tracks the top of the Document
264     // relative to the very top of the view.
265     WEBCORE_EXPORT IntSize documentScrollOffsetRelativeToViewOrigin() const;
266     IntPoint documentScrollPositionRelativeToViewOrigin() const;
267
268     virtual IntSize overhangAmount() const override;
269
270     void cacheCurrentScrollPosition() { m_cachedScrollPosition = scrollPosition(); }
271     IntPoint cachedScrollPosition() const { return m_cachedScrollPosition; }
272
273     // Functions for scrolling the view.
274     virtual void setScrollPosition(const IntPoint&);
275     void scrollBy(const IntSize& s) { return setScrollPosition(scrollPosition() + s); }
276
277     // This function scrolls by lines, pages or pixels.
278     bool scroll(ScrollDirection, ScrollGranularity);
279     
280     // A logical scroll that just ends up calling the corresponding physical scroll() based off the document's writing mode.
281     bool logicalScroll(ScrollLogicalDirection, ScrollGranularity);
282
283     // Scroll the actual contents of the view (either blitting or invalidating as needed).
284     void scrollContents(const IntSize& scrollDelta);
285
286     // This gives us a means of blocking painting on our scrollbars until the first layout has occurred.
287     WEBCORE_EXPORT void setScrollbarsSuppressed(bool suppressed, bool repaintOnUnsuppress = false);
288     bool scrollbarsSuppressed() const { return m_scrollbarsSuppressed; }
289
290     WEBCORE_EXPORT IntPoint rootViewToContents(const IntPoint&) const;
291     WEBCORE_EXPORT IntPoint contentsToRootView(const IntPoint&) const;
292     IntRect rootViewToContents(const IntRect&) const;
293     WEBCORE_EXPORT IntRect contentsToRootView(const IntRect&) const;
294
295     IntPoint viewToContents(const IntPoint&) const;
296     IntPoint contentsToView(const IntPoint&) const;
297
298     IntRect viewToContents(IntRect) const;
299     IntRect contentsToView(IntRect) const;
300
301     WEBCORE_EXPORT IntPoint rootViewToTotalContents(const IntPoint&) const;
302
303     // Event coordinates are assumed to be in the coordinate space of a window that contains
304     // the entire widget hierarchy. It is up to the platform to decide what the precise definition
305     // of containing window is. (For example on Mac it is the containing NSWindow.)
306     WEBCORE_EXPORT IntPoint windowToContents(const IntPoint&) const;
307     WEBCORE_EXPORT IntPoint contentsToWindow(const IntPoint&) const;
308     WEBCORE_EXPORT IntRect windowToContents(const IntRect&) const;
309     WEBCORE_EXPORT IntRect contentsToWindow(const IntRect&) const;
310
311     // Functions for converting to and from screen coordinates.
312     WEBCORE_EXPORT IntRect contentsToScreen(const IntRect&) const;
313     IntPoint screenToContents(const IntPoint&) const;
314
315     // 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
316     // we know that we are either not in a window right now or if that window is not visible.
317     bool isOffscreen() const;
318
319     // Called when our frame rect changes (or the rect/scroll position of an ancestor changes).
320     virtual void frameRectsChanged() override;
321     
322     // Widget override to update our scrollbars and notify our contents of the resize.
323     virtual void setFrameRect(const IntRect&) override;
324
325     // Widget override to notify our contents of a cliprect change.
326     virtual void clipRectChanged() override;
327
328     // For platforms that need to hit test scrollbars from within the engine's event handlers (like Win32).
329     Scrollbar* scrollbarAtPoint(const IntPoint& windowPoint);
330
331     IntPoint convertChildToSelf(const Widget* child, const IntPoint& point) const
332     {
333         IntPoint newPoint = point;
334         if (!isScrollViewScrollbar(child))
335             newPoint = point - scrollOffset();
336         newPoint.moveBy(child->location());
337         return newPoint;
338     }
339
340     IntPoint convertSelfToChild(const Widget* child, const IntPoint& point) const
341     {
342         IntPoint newPoint = point;
343         if (!isScrollViewScrollbar(child))
344             newPoint = point + scrollOffset();
345         newPoint.moveBy(-child->location());
346         return newPoint;
347     }
348
349     // Widget override. Handles painting of the contents of the view as well as the scrollbars.
350     WEBCORE_EXPORT virtual void paint(GraphicsContext*, const IntRect&) override;
351     void paintScrollbars(GraphicsContext*, const IntRect&);
352
353     // Widget overrides to ensure that our children's visibility status is kept up to date when we get shown and hidden.
354     WEBCORE_EXPORT virtual void show() override;
355     WEBCORE_EXPORT virtual void hide() override;
356     WEBCORE_EXPORT virtual void setParentVisible(bool) override;
357     
358     // Pan scrolling.
359     static const int noPanScrollRadius = 15;
360     void addPanScrollIcon(const IntPoint&);
361     void removePanScrollIcon();
362     void paintPanScrollIcon(GraphicsContext*);
363
364     virtual bool isPointInScrollbarCorner(const IntPoint&);
365     virtual bool scrollbarCornerPresent() const;
366     virtual IntRect scrollCornerRect() const override;
367     virtual void paintScrollCorner(GraphicsContext*, const IntRect& cornerRect);
368     virtual void paintScrollbar(GraphicsContext*, Scrollbar*, const IntRect&);
369
370     virtual IntRect convertFromScrollbarToContainingView(const Scrollbar*, const IntRect&) const override;
371     virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar*, const IntRect&) const override;
372     virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar*, const IntPoint&) const override;
373     virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar*, const IntPoint&) const override;
374
375     void calculateAndPaintOverhangAreas(GraphicsContext*, const IntRect& dirtyRect);
376
377     virtual bool isScrollView() const override { return true; }
378
379     WEBCORE_EXPORT void scrollPositionChangedViaPlatformWidget(const IntPoint& oldPosition, const IntPoint& newPosition);
380
381 protected:
382     ScrollView();
383
384     virtual void repaintContentRectangle(const IntRect&);
385     virtual void paintContents(GraphicsContext*, const IntRect& damageRect) = 0;
386
387     virtual void paintOverhangAreas(GraphicsContext*, const IntRect& horizontalOverhangArea, const IntRect& verticalOverhangArea, const IntRect& dirtyRect);
388
389     virtual void availableContentSizeChanged(AvailableSizeChangeReason) override;
390     virtual void addedOrRemovedScrollbar() = 0;
391     virtual void delegatesScrollingDidChange() { }
392
393     // These functions are used to create/destroy scrollbars.
394     // They return true if the scrollbar was added or removed.
395     bool setHasHorizontalScrollbar(bool, bool* contentSizeAffected = 0);
396     bool setHasVerticalScrollbar(bool, bool* contentSizeAffected = 0);
397
398     virtual void updateScrollCorner();
399     virtual void invalidateScrollCornerRect(const IntRect&) override;
400
401     // Scroll the content by blitting the pixels.
402     virtual bool scrollContentsFastPath(const IntSize& scrollDelta, const IntRect& rectToScroll, const IntRect& clipRect);
403     // Scroll the content by invalidating everything.
404     virtual void scrollContentsSlowPath(const IntRect& updateRect);
405
406     void setScrollOrigin(const IntPoint&, bool updatePositionAtAll, bool updatePositionSynchronously);
407
408     // Subclassed by FrameView to check the writing-mode of the document.
409     virtual bool isVerticalDocument() const { return true; }
410     virtual bool isFlippedDocument() const { return false; }
411     virtual bool containsSVGDocument() const { return false; }
412
413     // Called to update the scrollbars to accurately reflect the state of the view.
414     void updateScrollbars(const IntSize& desiredOffset);
415
416     float platformTopContentInset() const;
417     void platformSetTopContentInset(float);
418
419     virtual void handleDeferredScrollUpdateAfterContentSizeChange();
420
421     virtual bool shouldDeferScrollUpdateAfterContentSizeChange() { return false; }
422
423     virtual void scrollPositionChangedViaPlatformWidgetImpl(const IntPoint&, const IntPoint&) { }
424
425 private:
426     virtual IntRect visibleContentRectInternal(VisibleContentRectIncludesScrollbars, VisibleContentRectBehavior) const override;
427     WEBCORE_EXPORT IntRect unobscuredContentRectInternal(VisibleContentRectIncludesScrollbars = ExcludeScrollbars) const;
428
429     void completeUpdatesAfterScrollTo(const IntSize& scrollDelta);
430
431     RefPtr<Scrollbar> m_horizontalScrollbar;
432     RefPtr<Scrollbar> m_verticalScrollbar;
433     ScrollbarMode m_horizontalScrollbarMode;
434     ScrollbarMode m_verticalScrollbarMode;
435
436     bool m_horizontalScrollbarLock;
437     bool m_verticalScrollbarLock;
438
439     bool m_prohibitsScrolling;
440
441     HashSet<RefPtr<Widget>> m_children;
442
443     // This bool is unused on Mac OS because we directly ask the platform widget
444     // whether it is safe to blit on scroll.
445     bool m_canBlitOnScroll;
446
447     // FIXME: exposedContentRect is a very similar concept to fixedVisibleContentRect except it does not differentiate
448     // between exposed and unobscured areas. The two attributes should eventually be merged.
449 #if PLATFORM(IOS)
450     FloatRect m_exposedContentRect;
451     FloatSize m_unobscuredContentSize;
452 #else
453     IntRect m_fixedVisibleContentRect;
454 #endif
455     IntSize m_scrollOffset; // FIXME: Would rather store this as a position, but we will wait to make this change until more code is shared.
456     IntPoint m_cachedScrollPosition;
457     IntSize m_fixedLayoutSize;
458     IntSize m_contentsSize;
459
460     std::unique_ptr<IntSize> m_deferredScrollDelta; // Needed for WebKit scrolling
461     std::unique_ptr<std::pair<IntPoint, IntPoint>> m_deferredScrollPositions; // Needed for platform widget scrolling
462
463     bool m_scrollbarsSuppressed;
464
465     bool m_inUpdateScrollbars;
466     unsigned m_updateScrollbarsPass;
467
468     IntPoint m_panScrollIconPoint;
469     bool m_drawPanScrollIcon;
470     bool m_useFixedLayout;
471
472     bool m_paintsEntireContents;
473     bool m_clipsRepaints;
474     bool m_delegatesScrolling;
475
476     void init();
477     void destroy();
478
479     IntRect rectToCopyOnScroll() const;
480
481     // Called when the scroll position within this view changes.  FrameView overrides this to generate repaint invalidations.
482     virtual void updateLayerPositionsAfterScrolling() { }
483     virtual void updateCompositingLayersAfterScrolling() { }
484
485     void platformAddChild(Widget*);
486     void platformRemoveChild(Widget*);
487     void platformSetScrollbarModes();
488     void platformScrollbarModes(ScrollbarMode& horizontal, ScrollbarMode& vertical) const;
489     void platformSetCanBlitOnScroll(bool);
490     bool platformCanBlitOnScroll() const;
491     IntRect platformVisibleContentRect(bool includeScrollbars) const;
492     IntSize platformVisibleContentSize(bool includeScrollbars) const;
493     IntRect platformVisibleContentRectIncludingObscuredArea(bool includeScrollbars) const;
494     IntSize platformVisibleContentSizeIncludingObscuredArea(bool includeScrollbars) const;
495     void platformSetContentsSize();
496     IntRect platformContentsToScreen(const IntRect&) const;
497     IntPoint platformScreenToContents(const IntPoint&) const;
498     void platformSetScrollPosition(const IntPoint&);
499     bool platformScroll(ScrollDirection, ScrollGranularity);
500     void platformSetScrollbarsSuppressed(bool repaintOnUnsuppress);
501     void platformRepaintContentRectangle(const IntRect&);
502     bool platformIsOffscreen() const;
503     void platformSetScrollbarOverlayStyle(ScrollbarOverlayStyle);
504    
505     void platformSetScrollOrigin(const IntPoint&, bool updatePositionAtAll, bool updatePositionSynchronously);
506
507     void calculateOverhangAreasForPainting(IntRect& horizontalOverhangRect, IntRect& verticalOverhangRect);
508     void updateOverhangAreas();
509
510 #if PLATFORM(COCOA) && defined __OBJC__
511 public:
512     WEBCORE_EXPORT NSView* documentView() const;
513
514 private:
515     NSScrollView<WebCoreFrameScrollView>* scrollView() const;
516 #endif
517 }; // class ScrollView
518
519 } // namespace WebCore
520
521 SPECIALIZE_TYPE_TRAITS_WIDGET(ScrollView, isScrollView())
522
523 #endif // ScrollView_h