#ifndef ScrollView_h
#define ScrollView_h
#include "IntRect.h"
#include "Scrollbar.h"
#include "ScrollableArea.h"
#include "ScrollTypes.h"
#include "Widget.h"
#include <wtf/HashSet.h>
#if PLATFORM(MAC) && defined __OBJC__
@protocol WebCoreFrameScrollView;
#endif
#if PLATFORM(WX)
class wxScrollWinEvent;
#endif
namespace WebCore {
class HostWindow;
class Scrollbar;
class ScrollView : public Widget, public ScrollableArea {
public:
~ScrollView();
virtual int scrollSize(ScrollbarOrientation orientation) const;
virtual int scrollPosition(Scrollbar*) const;
virtual void setScrollOffset(const IntPoint&);
virtual void didCompleteRubberBand(const IntSize&) const;
virtual void notifyPageThatContentAreaWillPaint() const;
virtual bool isScrollCornerVisible() 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; }
void addChild(PassRefPtr<Widget>);
void removeChild(Widget*);
virtual Scrollbar* horizontalScrollbar() const { return m_horizontalScrollbar.get(); }
virtual Scrollbar* verticalScrollbar() const { 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);
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 setProhibitsScrolling(bool b) { m_prohibitsScrolling = b; }
bool prohibitsScrolling() const { return m_prohibitsScrolling; }
void setCanBlitOnScroll(bool);
bool canBlitOnScroll() const;
IntRect visibleContentRect(bool includeScrollbars = false) const;
IntRect actualVisibleContentRect() const { return m_actualVisibleContentRect.isEmpty() ? visibleContentRect() : m_actualVisibleContentRect; }
void setActualVisibleContentRect(const IntRect& actualVisibleContentRect) { m_actualVisibleContentRect = actualVisibleContentRect; }
int visibleWidth() const { return visibleContentRect().width(); }
int visibleHeight() const { return visibleContentRect().height(); }
int layoutWidth() const;
int layoutHeight() const;
IntSize fixedLayoutSize() const;
void setFixedLayoutSize(const IntSize&);
bool useFixedLayout() const;
void setUseFixedLayout(bool enable);
IntSize contentsSize() const; int contentsWidth() const { return contentsSize().width(); }
int contentsHeight() const { return contentsSize().height(); }
virtual void setContentsSize(const IntSize&);
IntPoint scrollPosition() const { return visibleContentRect().location(); }
IntSize scrollOffset() const { return visibleContentRect().location() - IntPoint(); } IntPoint maximumScrollPosition() const; IntPoint minimumScrollPosition() const; IntPoint adjustScrollPositionWithinRange(const IntPoint&) const;
int scrollX() const { return scrollPosition().x(); }
int scrollY() const { return scrollPosition().y(); }
IntSize overhangAmount() const;
void cacheCurrentScrollPosition() { m_cachedScrollPosition = scrollPosition(); }
IntPoint cachedScrollPosition() const { return m_cachedScrollPosition; }
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 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*);
virtual void frameRectsChanged();
virtual void setFrameRect(const IntRect&);
virtual void setBoundsSize(const IntSize&);
Scrollbar* scrollbarAtPoint(const IntPoint& windowPoint);
void wheelEvent(PlatformWheelEvent&);
#if ENABLE(GESTURE_EVENTS)
void gestureEvent(const PlatformGestureEvent&);
#endif
IntPoint convertChildToSelf(const Widget* child, const IntPoint& point) const
{
IntPoint newPoint = point;
if (!isScrollViewScrollbar(child))
newPoint = point - scrollOffset();
newPoint.move(child->x(), child->y());
return newPoint;
}
IntPoint convertSelfToChild(const Widget* child, const IntPoint& point) const
{
IntPoint newPoint = point;
if (!isScrollViewScrollbar(child))
newPoint = point + scrollOffset();
newPoint.move(-child->x(), -child->y());
return newPoint;
}
virtual void paint(GraphicsContext*, const IntRect&);
void paintScrollbars(GraphicsContext*, const IntRect&);
virtual void show();
virtual void hide();
virtual void setParentVisible(bool);
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;
virtual void paintScrollCorner(GraphicsContext*, const IntRect& cornerRect);
virtual IntRect convertFromScrollbarToContainingView(const Scrollbar*, const IntRect&) const;
virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar*, const IntRect&) const;
virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar*, const IntPoint&) const;
virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar*, const IntPoint&) const;
bool containsScrollableAreaWithOverlayScrollbars() const { return m_containsScrollableAreaWithOverlayScrollbars; }
void setContainsScrollableAreaWithOverlayScrollbars(bool contains) { m_containsScrollableAreaWithOverlayScrollbars = contains; }
protected:
ScrollView();
virtual void repaintContentRectangle(const IntRect&, bool now = false);
virtual void paintContents(GraphicsContext*, const IntRect& damageRect) = 0;
void calculateOverhangAreasForPainting(IntRect& horizontalOverhangRect, IntRect& verticalOverhangRect);
virtual void paintOverhangAreas(GraphicsContext*, const IntRect& horizontalOverhangArea, const IntRect& verticalOverhangArea, const IntRect& dirtyRect);
virtual void contentsResized() = 0;
virtual void visibleContentsResized() = 0;
IntSize boundsSize() const { return m_boundsSize; }
void setInitialBoundsSize(const IntSize&);
void setHasHorizontalScrollbar(bool);
void setHasVerticalScrollbar(bool);
virtual void updateScrollCorner();
virtual void invalidateScrollCornerRect(const IntRect&);
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);
IntPoint scrollOrigin() const { return m_scrollOrigin; }
virtual bool isVerticalDocument() const { return true; }
virtual bool isFlippedDocument() const { return false; }
private:
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;
IntRect m_actualVisibleContentRect;
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;
bool m_containsScrollableAreaWithOverlayScrollbars;
IntSize m_boundsSize;
void init();
void destroy();
void updateScrollbars(const IntSize& desiredOffset);
IntRect rectToCopyOnScroll() const;
virtual void repaintFixedElementsAfterScrolling() {}
void platformInit();
void platformDestroy();
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 platformContentsSize() 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 now);
bool platformIsOffscreen() const;
void platformSetScrollbarOverlayStyle(ScrollbarOverlayStyle);
void platformSetScrollOrigin(const IntPoint&, bool updatePositionAtAll, bool updatePositionSynchronously);
#if PLATFORM(MAC) && defined __OBJC__
public:
NSView* documentView() const;
private:
NSScrollView<WebCoreFrameScrollView>* scrollView() const;
#endif
#if PLATFORM(WX)
public:
virtual void setPlatformWidget(wxWindow*);
void adjustScrollbars(int x = -1, int y = -1, bool refresh = true);
private:
class ScrollViewPrivate;
ScrollViewPrivate* m_data;
#endif
};
}
#endif // ScrollView_h