#ifndef ScrollView_h
#define ScrollView_h
#include "FloatRect.h"
#include "IntRect.h"
#include "Scrollbar.h"
#include "ScrollableArea.h"
#include "ScrollTypes.h"
#include "Widget.h"
#include <wtf/HashSet.h>
#if PLATFORM(IOS)
#ifdef __OBJC__
@class WAKScrollView;
@class WAKView;
#else
class WAKScrollView;
class WAKView;
#endif
#ifndef NSScrollView
#define NSScrollView WAKScrollView
#endif
#ifndef NSView
#define NSView WAKView
#endif
#endif // PLATFORM(IOS)
#if PLATFORM(COCOA) && defined __OBJC__
@protocol WebCoreFrameScrollView;
#endif
namespace WebCore {
class HostWindow;
class LegacyTileCache;
class Scrollbar;
class ScrollView : public Widget, public ScrollableArea {
public:
virtual ~ScrollView();
virtual int scrollSize(ScrollbarOrientation) const override;
virtual int scrollPosition(Scrollbar*) const override;
virtual void setScrollOffset(const IntPoint&) override;
virtual bool isScrollCornerVisible() const override;
virtual void scrollbarStyleChanged(int newStyle, bool forceUpdate) override;
virtual void notifyPageThatContentAreaWillPaint() const;
virtual void scrollTo(const IntSize& newOffset);
virtual HostWindow* hostWindow() const = 0;
virtual IntRect windowClipRect(bool clipToContents = true) const = 0;
const HashSet<RefPtr<Widget>>& children() const { return m_children; }
virtual void addChild(PassRefPtr<Widget>);
virtual void removeChild(Widget*);
virtual Scrollbar* horizontalScrollbar() const override { return m_horizontalScrollbar.get(); }
virtual Scrollbar* verticalScrollbar() const override { return m_verticalScrollbar.get(); }
bool isScrollViewScrollbar(const Widget* child) const { return horizontalScrollbar() == child || verticalScrollbar() == child; }
void positionScrollbarLayers();
void setScrollbarModes(ScrollbarMode horizontalMode, ScrollbarMode verticalMode, bool horizontalLock = false, bool verticalLock = false);
void setHorizontalScrollbarMode(ScrollbarMode mode, bool lock = false) { setScrollbarModes(mode, verticalScrollbarMode(), lock, verticalScrollbarLock()); }
void setVerticalScrollbarMode(ScrollbarMode mode, bool lock = false) { setScrollbarModes(horizontalScrollbarMode(), mode, horizontalScrollbarLock(), lock); };
void scrollbarModes(ScrollbarMode& horizontalMode, ScrollbarMode& verticalMode) const;
ScrollbarMode horizontalScrollbarMode() const { ScrollbarMode horizontal, vertical; scrollbarModes(horizontal, vertical); return horizontal; }
ScrollbarMode verticalScrollbarMode() const { ScrollbarMode horizontal, vertical; scrollbarModes(horizontal, vertical); return vertical; }
void setHorizontalScrollbarLock(bool lock = true) { m_horizontalScrollbarLock = lock; }
bool horizontalScrollbarLock() const { return m_horizontalScrollbarLock; }
void setVerticalScrollbarLock(bool lock = true) { m_verticalScrollbarLock = lock; }
bool verticalScrollbarLock() const { return m_verticalScrollbarLock; }
void setScrollingModesLock(bool lock = true) { m_horizontalScrollbarLock = m_verticalScrollbarLock = lock; }
virtual void setCanHaveScrollbars(bool);
bool canHaveScrollbars() const { return horizontalScrollbarMode() != ScrollbarAlwaysOff || verticalScrollbarMode() != ScrollbarAlwaysOff; }
virtual bool avoidScrollbarCreation() const { return false; }
virtual void setScrollbarOverlayStyle(ScrollbarOverlayStyle) override;
bool paintsEntireContents() const { return m_paintsEntireContents; }
void setPaintsEntireContents(bool);
bool clipsRepaints() const { return m_clipsRepaints; }
void setClipsRepaints(bool);
bool delegatesScrolling() const { return m_delegatesScrolling; }
void setDelegatesScrolling(bool);
virtual PassRefPtr<Scrollbar> createScrollbar(ScrollbarOrientation);
void styleDidChange();
void setProhibitsScrolling(bool b) { m_prohibitsScrolling = b; }
bool prohibitsScrolling() const { return m_prohibitsScrolling; }
void setCanBlitOnScroll(bool);
bool canBlitOnScroll() const;
virtual float topContentInset() const { return 0; }
virtual IntSize visibleSize() const override { return visibleContentRect(LegacyIOSDocumentVisibleRect).size(); }
#if USE(TILED_BACKING_STORE)
virtual void setFixedVisibleContentRect(const IntRect& visibleContentRect) { m_fixedVisibleContentRect = visibleContentRect; }
IntRect fixedVisibleContentRect() const { return m_fixedVisibleContentRect; }
#endif
IntRect unobscuredContentRect(VisibleContentRectIncludesScrollbars = ExcludeScrollbars) const;
#if PLATFORM(IOS)
IntRect unobscuredContentRectIncludingScrollbars() const { return unobscuredContentRect(IncludeScrollbars); }
#else
IntRect unobscuredContentRectIncludingScrollbars() const { return visibleContentRectIncludingScrollbars(); }
#endif
#if PLATFORM(IOS)
FloatRect exposedContentRect() const;
void setExposedContentRect(const FloatRect&);
const FloatSize& unobscuredContentSize() const { return m_unobscuredContentSize; }
void setUnobscuredContentSize(const FloatSize&);
void setActualScrollPosition(const IntPoint&);
LegacyTileCache* legacyTileCache();
#endif
virtual bool inProgrammaticScroll() const { return false; }
IntSize unscaledUnobscuredVisibleContentSize(VisibleContentRectIncludesScrollbars = ExcludeScrollbars) const;
IntSize unscaledTotalVisibleContentSize(VisibleContentRectIncludesScrollbars = ExcludeScrollbars) const;
virtual float visibleContentScaleFactor() const { return 1; }
IntSize layoutSize() const;
int layoutWidth() const { return layoutSize().width(); }
int layoutHeight() const { return layoutSize().height(); }
IntSize fixedLayoutSize() const;
void setFixedLayoutSize(const IntSize&);
bool useFixedLayout() const;
void setUseFixedLayout(bool enable);
virtual IntSize contentsSize() const override; int contentsWidth() const { return contentsSize().width(); }
int contentsHeight() const { return contentsSize().height(); }
virtual void setContentsSize(const IntSize&);
virtual IntPoint scrollPosition() const override { return visibleContentRect(LegacyIOSDocumentVisibleRect).location(); }
IntSize scrollOffset() const { return toIntSize(visibleContentRect(LegacyIOSDocumentVisibleRect).location()); } virtual IntPoint maximumScrollPosition() const override; virtual IntPoint minimumScrollPosition() const override; IntPoint adjustScrollPositionWithinRange(const IntPoint&) const;
int scrollX() const { return scrollPosition().x(); }
int scrollY() const { return scrollPosition().y(); }
IntPoint contentsScrollPosition() const;
void setContentsScrollPosition(const IntPoint&);
#if PLATFORM(IOS)
int actualScrollX() const { return unobscuredContentRect().x(); }
int actualScrollY() const { return unobscuredContentRect().y(); }
IntPoint actualScrollPosition() const { return unobscuredContentRect().location(); }
#endif
IntSize documentScrollOffsetRelativeToScrollableAreaOrigin() const;
IntSize documentScrollOffsetRelativeToViewOrigin() const;
IntPoint documentScrollPositionRelativeToViewOrigin() const;
virtual IntSize overhangAmount() const override;
void cacheCurrentScrollPosition() { m_cachedScrollPosition = scrollPosition(); }
IntPoint cachedScrollPosition() const { return m_cachedScrollPosition; }
virtual void setScrollPosition(const IntPoint&);
void scrollBy(const IntSize& s) { return setScrollPosition(scrollPosition() + s); }
bool scroll(ScrollDirection, ScrollGranularity);
bool logicalScroll(ScrollLogicalDirection, ScrollGranularity);
void scrollContents(const IntSize& scrollDelta);
void setScrollbarsSuppressed(bool suppressed, bool repaintOnUnsuppress = false);
bool scrollbarsSuppressed() const { return m_scrollbarsSuppressed; }
IntPoint rootViewToContents(const IntPoint&) const;
IntPoint contentsToRootView(const IntPoint&) const;
IntRect rootViewToContents(const IntRect&) const;
IntRect contentsToRootView(const IntRect&) const;
IntPoint rootViewToTotalContents(const IntPoint&) const;
IntPoint windowToContents(const IntPoint&) const;
IntPoint contentsToWindow(const IntPoint&) const;
IntRect windowToContents(const IntRect&) const;
IntRect contentsToWindow(const IntRect&) const;
IntRect contentsToScreen(const IntRect&) const;
IntPoint screenToContents(const IntPoint&) const;
bool isOffscreen() const;
virtual IntRect windowResizerRect() const { return IntRect(); }
bool containsScrollbarsAvoidingResizer() const;
void adjustScrollbarsAvoidingResizerCount(int overlapDelta);
void windowResizerRectChanged();
virtual void setParent(ScrollView*) override;
virtual void frameRectsChanged() override;
virtual void setFrameRect(const IntRect&) override;
virtual void clipRectChanged() override;
Scrollbar* scrollbarAtPoint(const IntPoint& windowPoint);
IntPoint convertChildToSelf(const Widget* child, const IntPoint& point) const
{
IntPoint newPoint = point;
if (!isScrollViewScrollbar(child))
newPoint = point - scrollOffset();
newPoint.moveBy(child->location());
return newPoint;
}
IntPoint convertSelfToChild(const Widget* child, const IntPoint& point) const
{
IntPoint newPoint = point;
if (!isScrollViewScrollbar(child))
newPoint = point + scrollOffset();
newPoint.moveBy(-child->location());
return newPoint;
}
virtual void paint(GraphicsContext*, const IntRect&) override;
void paintScrollbars(GraphicsContext*, const IntRect&);
virtual void show() override;
virtual void hide() override;
virtual void setParentVisible(bool) override;
static const int noPanScrollRadius = 15;
void addPanScrollIcon(const IntPoint&);
void removePanScrollIcon();
void paintPanScrollIcon(GraphicsContext*);
virtual bool isPointInScrollbarCorner(const IntPoint&);
virtual bool scrollbarCornerPresent() const;
virtual IntRect scrollCornerRect() const override;
virtual void paintScrollCorner(GraphicsContext*, const IntRect& cornerRect);
virtual void paintScrollbar(GraphicsContext*, Scrollbar*, const IntRect&);
virtual IntRect convertFromScrollbarToContainingView(const Scrollbar*, const IntRect&) const override;
virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar*, const IntRect&) const override;
virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar*, const IntPoint&) const override;
virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar*, const IntPoint&) const override;
void calculateAndPaintOverhangAreas(GraphicsContext*, const IntRect& dirtyRect);
virtual bool isScrollView() const override { return true; }
protected:
ScrollView();
virtual void repaintContentRectangle(const IntRect&);
virtual void paintContents(GraphicsContext*, const IntRect& damageRect) = 0;
virtual void paintOverhangAreas(GraphicsContext*, const IntRect& horizontalOverhangArea, const IntRect& verticalOverhangArea, const IntRect& dirtyRect);
virtual void visibleContentsResized() = 0;
virtual void addedOrRemovedScrollbar() = 0;
virtual void delegatesScrollingDidChange() { }
virtual void fixedLayoutSizeChanged();
bool setHasHorizontalScrollbar(bool, bool* contentSizeAffected = 0);
bool setHasVerticalScrollbar(bool, bool* contentSizeAffected = 0);
virtual void updateScrollCorner();
virtual void invalidateScrollCornerRect(const IntRect&) override;
virtual bool scrollContentsFastPath(const IntSize& scrollDelta, const IntRect& rectToScroll, const IntRect& clipRect);
virtual void scrollContentsSlowPath(const IntRect& updateRect);
void setScrollOrigin(const IntPoint&, bool updatePositionAtAll, bool updatePositionSynchronously);
virtual bool isVerticalDocument() const { return true; }
virtual bool isFlippedDocument() const { return false; }
void updateScrollbars(const IntSize& desiredOffset);
private:
virtual IntRect visibleContentRectInternal(VisibleContentRectIncludesScrollbars, VisibleContentRectBehavior) const override;
IntRect unobscuredContentRectInternal(VisibleContentRectIncludesScrollbars = ExcludeScrollbars) const;
RefPtr<Scrollbar> m_horizontalScrollbar;
RefPtr<Scrollbar> m_verticalScrollbar;
ScrollbarMode m_horizontalScrollbarMode;
ScrollbarMode m_verticalScrollbarMode;
bool m_horizontalScrollbarLock;
bool m_verticalScrollbarLock;
bool m_prohibitsScrolling;
HashSet<RefPtr<Widget>> m_children;
bool m_canBlitOnScroll;
#if PLATFORM(IOS)
FloatRect m_exposedContentRect;
FloatSize m_unobscuredContentSize;
#else
IntRect m_fixedVisibleContentRect;
#endif
IntSize m_scrollOffset; IntPoint m_cachedScrollPosition;
IntSize m_fixedLayoutSize;
IntSize m_contentsSize;
int m_scrollbarsAvoidingResizer;
bool m_scrollbarsSuppressed;
bool m_inUpdateScrollbars;
unsigned m_updateScrollbarsPass;
IntPoint m_panScrollIconPoint;
bool m_drawPanScrollIcon;
bool m_useFixedLayout;
bool m_paintsEntireContents;
bool m_clipsRepaints;
bool m_delegatesScrolling;
void init();
void destroy();
IntRect rectToCopyOnScroll() const;
virtual void updateLayerPositionsAfterScrolling() { }
virtual void updateCompositingLayersAfterScrolling() { }
void platformAddChild(Widget*);
void platformRemoveChild(Widget*);
void platformSetScrollbarModes();
void platformScrollbarModes(ScrollbarMode& horizontal, ScrollbarMode& vertical) const;
void platformSetCanBlitOnScroll(bool);
bool platformCanBlitOnScroll() const;
IntRect platformVisibleContentRect(bool includeScrollbars) const;
IntSize platformVisibleContentSize(bool includeScrollbars) const;
void platformSetContentsSize();
IntRect platformContentsToScreen(const IntRect&) const;
IntPoint platformScreenToContents(const IntPoint&) const;
void platformSetScrollPosition(const IntPoint&);
bool platformScroll(ScrollDirection, ScrollGranularity);
void platformSetScrollbarsSuppressed(bool repaintOnUnsuppress);
void platformRepaintContentRectangle(const IntRect&);
bool platformIsOffscreen() const;
void platformSetScrollbarOverlayStyle(ScrollbarOverlayStyle);
void platformSetScrollOrigin(const IntPoint&, bool updatePositionAtAll, bool updatePositionSynchronously);
void calculateOverhangAreasForPainting(IntRect& horizontalOverhangRect, IntRect& verticalOverhangRect);
void updateOverhangAreas();
#if PLATFORM(COCOA) && defined __OBJC__
public:
NSView* documentView() const;
private:
NSScrollView<WebCoreFrameScrollView>* scrollView() const;
#endif
};
WIDGET_TYPE_CASTS(ScrollView, isScrollView());
}
#endif // ScrollView_h