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