#ifndef ScrollableArea_h
#define ScrollableArea_h
#include "platform/PlatformExport.h"
#include "platform/scroll/ScrollAnimator.h"
#include "platform/scroll/Scrollbar.h"
#include "wtf/Noncopyable.h"
#include "wtf/Vector.h"
namespace WebCore {
class FloatPoint;
class GraphicsContext;
class GraphicsLayer;
class PlatformGestureEvent;
class PlatformWheelEvent;
class ScrollAnimator;
enum ScrollBehavior {
ScrollBehaviorAuto,
ScrollBehaviorInstant,
ScrollBehaviorSmooth,
};
enum IncludeScrollbarsInRect {
ExcludeScrollbars,
IncludeScrollbars,
};
class PLATFORM_EXPORT ScrollableArea {
WTF_MAKE_NONCOPYABLE(ScrollableArea);
public:
static int pixelsPerLineStep();
static float minFractionToStepWhenPaging();
static int maxOverlapBetweenPages();
bool scroll(ScrollDirection, ScrollGranularity, float delta = 1);
void scrollToOffsetWithoutAnimation(const FloatPoint&);
void scrollToOffsetWithoutAnimation(ScrollbarOrientation, float offset);
void notifyScrollPositionChanged(const IntPoint&);
static bool scrollBehaviorFromString(const String&, ScrollBehavior&);
bool handleWheelEvent(const PlatformWheelEvent&);
bool constrainsScrollingToContentEdge() const { return m_constrainsScrollingToContentEdge; }
void setConstrainsScrollingToContentEdge(bool constrainsScrollingToContentEdge) { m_constrainsScrollingToContentEdge = constrainsScrollingToContentEdge; }
void setVerticalScrollElasticity(ScrollElasticity scrollElasticity) { m_verticalScrollElasticity = scrollElasticity; }
ScrollElasticity verticalScrollElasticity() const { return static_cast<ScrollElasticity>(m_verticalScrollElasticity); }
void setHorizontalScrollElasticity(ScrollElasticity scrollElasticity) { m_horizontalScrollElasticity = scrollElasticity; }
ScrollElasticity horizontalScrollElasticity() const { return static_cast<ScrollElasticity>(m_horizontalScrollElasticity); }
bool inLiveResize() const { return m_inLiveResize; }
void willStartLiveResize();
void willEndLiveResize();
void contentAreaWillPaint() const;
void mouseEnteredContentArea() const;
void mouseExitedContentArea() const;
void mouseMovedInContentArea() const;
void mouseEnteredScrollbar(Scrollbar*) const;
void mouseExitedScrollbar(Scrollbar*) const;
void contentAreaDidShow() const;
void contentAreaDidHide() const;
void finishCurrentScrollAnimations() const;
virtual void didAddScrollbar(Scrollbar*, ScrollbarOrientation);
virtual void willRemoveScrollbar(Scrollbar*, ScrollbarOrientation);
virtual void contentsResized();
bool hasOverlayScrollbars() const;
void setScrollbarOverlayStyle(ScrollbarOverlayStyle);
ScrollbarOverlayStyle scrollbarOverlayStyle() const { return static_cast<ScrollbarOverlayStyle>(m_scrollbarOverlayStyle); }
ScrollAnimator* scrollAnimator() const;
ScrollAnimator* existingScrollAnimator() const { return m_scrollAnimator.get(); }
const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
bool scrollOriginChanged() const { return m_scrollOriginChanged; }
virtual bool isActive() const = 0;
virtual int scrollSize(ScrollbarOrientation) const = 0;
virtual void invalidateScrollbar(Scrollbar*, const IntRect&);
virtual bool isScrollCornerVisible() const = 0;
virtual IntRect scrollCornerRect() const = 0;
virtual void invalidateScrollCorner(const IntRect&);
virtual void getTickmarks(Vector<IntRect>&) const { }
virtual IntRect convertFromScrollbarToContainingView(const Scrollbar* scrollbar, const IntRect& scrollbarRect) const
{
return scrollbar->Widget::convertToContainingView(scrollbarRect);
}
virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar* scrollbar, const IntRect& parentRect) const
{
return scrollbar->Widget::convertFromContainingView(parentRect);
}
virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar* scrollbar, const IntPoint& scrollbarPoint) const
{
return scrollbar->Widget::convertToContainingView(scrollbarPoint);
}
virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar* scrollbar, const IntPoint& parentPoint) const
{
return scrollbar->Widget::convertFromContainingView(parentPoint);
}
virtual Scrollbar* horizontalScrollbar() const { return 0; }
virtual Scrollbar* verticalScrollbar() const { return 0; }
virtual IntPoint scrollPosition() const = 0;
virtual IntPoint minimumScrollPosition() const = 0;
virtual IntPoint maximumScrollPosition() const = 0;
virtual IntRect visibleContentRect(IncludeScrollbarsInRect = ExcludeScrollbars) const;
virtual int visibleHeight() const = 0;
virtual int visibleWidth() const = 0;
virtual IntSize contentsSize() const = 0;
virtual IntSize overhangAmount() const { return IntSize(); }
virtual IntPoint lastKnownMousePosition() const { return IntPoint(); }
virtual bool shouldSuspendScrollAnimations() const { return true; }
virtual void scrollbarStyleChanged(int , bool ) { }
virtual bool scrollbarsCanBeActive() const = 0;
virtual IntRect scrollableAreaBoundingBox() const = 0;
virtual bool shouldRubberBandInDirection(ScrollDirection) const { return true; }
virtual bool isRubberBandInProgress() const { return false; }
virtual bool scrollAnimatorEnabled() const { return false; }
void setScrollOffsetFromInternals(const IntPoint&);
IntPoint clampScrollPosition(const IntPoint&) const;
virtual bool scheduleAnimation() { return false; }
void serviceScrollAnimations();
virtual bool usesCompositedScrolling() const { return false; }
virtual void updateNeedsCompositedScrolling() { }
virtual void updateHasVisibleNonLayerContent() { }
virtual bool userInputScrollable(ScrollbarOrientation) const = 0;
virtual bool shouldPlaceVerticalScrollbarOnLeft() const = 0;
int scrollPosition(ScrollbarOrientation orientation) { return orientation == HorizontalScrollbar ? scrollPosition().x() : scrollPosition().y(); }
int minimumScrollPosition(ScrollbarOrientation orientation) { return orientation == HorizontalScrollbar ? minimumScrollPosition().x() : minimumScrollPosition().y(); }
int maximumScrollPosition(ScrollbarOrientation orientation) { return orientation == HorizontalScrollbar ? maximumScrollPosition().x() : maximumScrollPosition().y(); }
int clampScrollPosition(ScrollbarOrientation orientation, int pos) { return std::max(std::min(pos, maximumScrollPosition(orientation)), minimumScrollPosition(orientation)); }
bool hasVerticalBarDamage() const { return m_hasVerticalBarDamage; }
bool hasHorizontalBarDamage() const { return m_hasHorizontalBarDamage; }
const IntRect& verticalBarDamage() const
{
ASSERT(m_hasVerticalBarDamage);
return m_verticalBarDamage;
}
const IntRect& horizontalBarDamage() const
{
ASSERT(m_hasHorizontalBarDamage);
return m_horizontalBarDamage;
}
void resetScrollbarDamage()
{
m_hasVerticalBarDamage = false;
m_hasHorizontalBarDamage = false;
}
virtual GraphicsLayer* layerForContainer() const;
virtual GraphicsLayer* layerForScrolling() const { return 0; }
virtual GraphicsLayer* layerForHorizontalScrollbar() const { return 0; }
virtual GraphicsLayer* layerForVerticalScrollbar() const { return 0; }
virtual GraphicsLayer* layerForScrollCorner() const { return 0; }
bool hasLayerForHorizontalScrollbar() const;
bool hasLayerForVerticalScrollbar() const;
bool hasLayerForScrollCorner() const;
protected:
ScrollableArea();
virtual ~ScrollableArea();
void setScrollOrigin(const IntPoint&);
void resetScrollOriginChanged() { m_scrollOriginChanged = false; }
virtual void invalidateScrollbarRect(Scrollbar*, const IntRect&) = 0;
virtual void invalidateScrollCornerRect(const IntRect&) = 0;
unsigned m_hasHorizontalBarDamage : 1;
unsigned m_hasVerticalBarDamage : 1;
IntRect m_horizontalBarDamage;
IntRect m_verticalBarDamage;
private:
void scrollPositionChanged(const IntPoint&);
friend class ScrollAnimator;
void setScrollOffsetFromAnimation(const IntPoint&);
virtual void setScrollOffset(const IntPoint&) = 0;
virtual int lineStep(ScrollbarOrientation) const;
virtual int pageStep(ScrollbarOrientation) const;
virtual int documentStep(ScrollbarOrientation) const;
virtual float pixelStep(ScrollbarOrientation) const;
mutable OwnPtr<ScrollAnimator> m_scrollAnimator;
unsigned m_constrainsScrollingToContentEdge : 1;
unsigned m_inLiveResize : 1;
unsigned m_verticalScrollElasticity : 2;
unsigned m_horizontalScrollElasticity : 2;
unsigned m_scrollbarOverlayStyle : 2;
unsigned m_scrollOriginChanged : 1;
IntPoint m_scrollOrigin;
};
}
#endif