code.vuplus.com Git - vuplus_webkit/blob - Source/WebCore/platform/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 "ScrollTypes.h"
  35 #include <wtf/Forward.h>
  36
  37 namespace WebCore {
  38
  39 class FloatPoint;
  40 class PlatformWheelEvent;
  41 class ScrollableArea;
  42 class Scrollbar;
  43
  44 #if ENABLE(GESTURE_EVENTS)
  45 class PlatformGestureEvent;
  46 #endif
  47
  48 class ScrollAnimator {
  49 public:
  50     static PassOwnPtr<ScrollAnimator> create(ScrollableArea*);
  51
  52     virtual ~ScrollAnimator();
  53
  54     // Computes a scroll destination for the given parameters.  Returns false if
  55     // already at the destination.  Otherwise, starts scrolling towards the
  56     // destination and returns true.  Scrolling may be immediate or animated.
  57     // The base class implementation always scrolls immediately, never animates.
  58     virtual bool scroll(ScrollbarOrientation, ScrollGranularity, float step, float multiplier);
  59
  60     virtual void scrollToOffsetWithoutAnimation(const FloatPoint&);
  61
  62     ScrollableArea* scrollableArea() const { return m_scrollableArea; }
  63
  64     virtual void setIsActive() { }
  65
  66     virtual void handleWheelEvent(PlatformWheelEvent&);
  67 #if ENABLE(GESTURE_EVENTS)
  68     virtual void handleGestureEvent(const PlatformGestureEvent&);
  69 #endif
  70
  71     FloatPoint currentPosition() const;
  72
  73     virtual void cancelAnimations() { }
  74
  75     virtual void contentAreaWillPaint() const { }
  76     virtual void mouseEnteredContentArea() const { }
  77     virtual void mouseExitedContentArea() const { }
  78     virtual void mouseMovedInContentArea() const { }
  79     virtual void willStartLiveResize() { }
  80     virtual void contentsResized() const { }
  81     virtual void willEndLiveResize() { }
  82     virtual void contentAreaDidShow() const { }
  83     virtual void contentAreaDidHide() const { }
  84
  85     virtual void didAddVerticalScrollbar(Scrollbar*) { }
  86     virtual void willRemoveVerticalScrollbar(Scrollbar*) { }
  87     virtual void didAddHorizontalScrollbar(Scrollbar*) { }
  88     virtual void willRemoveHorizontalScrollbar(Scrollbar*) { }
  89
  90 protected:
  91     ScrollAnimator(ScrollableArea*);
  92
  93     virtual void notifyPositionChanged();
  94
  95     ScrollableArea* m_scrollableArea;
  96     float m_currentPosX; // We avoid using a FloatPoint in order to reduce
  97     float m_currentPosY; // subclass code complexity.
  98 };
  99
 100 } // namespace WebCore
 101
 102 #endif // ScrollAnimator_h