2 * Copyright (c) 2010, Google Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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
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.
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.
31 #ifndef ScrollAnimator_h
32 #define ScrollAnimator_h
34 #include "ScrollTypes.h"
35 #include <wtf/Forward.h>
40 class PlatformWheelEvent;
44 #if ENABLE(GESTURE_EVENTS)
45 class PlatformGestureEvent;
48 class ScrollAnimator {
50 static PassOwnPtr<ScrollAnimator> create(ScrollableArea*);
52 virtual ~ScrollAnimator();
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);
60 virtual void scrollToOffsetWithoutAnimation(const FloatPoint&);
62 ScrollableArea* scrollableArea() const { return m_scrollableArea; }
64 virtual void handleWheelEvent(PlatformWheelEvent&);
65 #if ENABLE(GESTURE_EVENTS)
66 virtual void handleGestureEvent(const PlatformGestureEvent&);
69 FloatPoint currentPosition() const;
71 virtual void contentAreaWillPaint() const { }
72 virtual void mouseEnteredContentArea() const { }
73 virtual void mouseExitedContentArea() const { }
74 virtual void mouseMovedInContentArea() const { }
75 virtual void willStartLiveResize() { }
76 virtual void contentsResized() const { }
77 virtual void willEndLiveResize() { }
78 virtual void contentAreaDidShow() const { }
79 virtual void contentAreaDidHide() const { }
81 virtual void didAddVerticalScrollbar(Scrollbar*) { }
82 virtual void willRemoveVerticalScrollbar(Scrollbar*) { }
83 virtual void didAddHorizontalScrollbar(Scrollbar*) { }
84 virtual void willRemoveHorizontalScrollbar(Scrollbar*) { }
87 ScrollAnimator(ScrollableArea*);
89 virtual void notityPositionChanged();
91 ScrollableArea* m_scrollableArea;
92 float m_currentPosX; // We avoid using a FloatPoint in order to reduce
93 float m_currentPosY; // subclass code complexity.
96 } // namespace WebCore
98 #endif // ScrollAnimator_h