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