src/third_party/WebKit/Source/platform/scroll/ScrollAnimator.h

   1 /*
   2  * Copyright (c) 2010, Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef ScrollAnimator_h
  32 #define ScrollAnimator_h
  33
  34 #include "platform/PlatformExport.h"
  35 #include "platform/PlatformWheelEvent.h"
  36 #include "platform/geometry/FloatSize.h"
  37 #include "platform/scroll/ScrollTypes.h"
  38 #include "wtf/Forward.h"
  39 #include "wtf/RefCounted.h"
  40
  41 namespace blink {
  42
  43 class FloatPoint;
  44 class ScrollableArea;
  45 class Scrollbar;
  46
  47 class PLATFORM_EXPORT ScrollAnimator : public RefCounted<ScrollAnimator> {
  48 public:
  49     static PassRefPtr<ScrollAnimator> create(ScrollableArea*);
  50
  51     virtual ~ScrollAnimator();
  52
  53     // Computes a scroll destination for the given parameters.  Returns false if
  54     // already at the destination.  Otherwise, starts scrolling towards the
  55     // destination and returns true.  Scrolling may be immediate or animated.
  56     // The base class implementation always scrolls immediately, never animates.
  57     virtual bool scroll(ScrollbarOrientation, ScrollGranularity, float step, float delta);
  58
  59     virtual void scrollToOffsetWithoutAnimation(const FloatPoint&);
  60
  61     ScrollableArea* scrollableArea() const { return m_scrollableArea; }
  62
  63     virtual void setIsActive() { }
  64
  65     virtual bool handleWheelEvent(const PlatformWheelEvent&);
  66
  67 #if OS(MACOSX)
  68     virtual void handleWheelEventPhase(PlatformWheelEventPhase) { }
  69 #endif
  70
  71     void setCurrentPosition(const FloatPoint&);
  72     FloatPoint currentPosition() const;
  73
  74     virtual void cancelAnimations() { }
  75     virtual void serviceScrollAnimations() { }
  76
  77     virtual void contentAreaWillPaint() const { }
  78     virtual void mouseEnteredContentArea() const { }
  79     virtual void mouseExitedContentArea() const { }
  80     virtual void mouseMovedInContentArea() const { }
  81     virtual void mouseEnteredScrollbar(Scrollbar*) const { }
  82     virtual void mouseExitedScrollbar(Scrollbar*) const { }
  83     virtual void willStartLiveResize() { }
  84     virtual void contentsResized() const { }
  85     virtual void willEndLiveResize() { }
  86     virtual void contentAreaDidShow() const { }
  87     virtual void contentAreaDidHide() const { }
  88
  89     virtual void finishCurrentScrollAnimations() { }
  90
  91     virtual void didAddVerticalScrollbar(Scrollbar*) { }
  92     virtual void willRemoveVerticalScrollbar(Scrollbar*) { }
  93     virtual void didAddHorizontalScrollbar(Scrollbar*) { }
  94     virtual void willRemoveHorizontalScrollbar(Scrollbar*) { }
  95
  96     virtual bool shouldScrollbarParticipateInHitTesting(Scrollbar*) { return true; }
  97
  98     virtual void notifyContentAreaScrolled(const FloatSize&) { }
  99
 100     virtual bool isRubberBandInProgress() const { return false; }
 101
 102 protected:
 103     explicit ScrollAnimator(ScrollableArea*);
 104
 105     virtual void notifyPositionChanged();
 106
 107     ScrollableArea* m_scrollableArea;
 108     float m_currentPosX; // We avoid using a FloatPoint in order to reduce
 109     float m_currentPosY; // subclass code complexity.
 110
 111 private:
 112     float clampScrollPosition(ScrollbarOrientation, float);
 113 };
 114
 115 } // namespace blink
 116
 117 #endif // ScrollAnimator_h