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