cd1e897038eeeab5d1733a25f574ffa5701728b9
[WebKit-https.git] / Source / WebCore / platform / Scrollbar.h
1 /*
2  * Copyright (C) 2004, 2006 Apple Computer, 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef Scrollbar_h
27 #define Scrollbar_h
28
29 #include "ScrollbarThemeClient.h"
30 #include "ScrollTypes.h"
31 #include "Timer.h"
32 #include "Widget.h"
33 #include <wtf/MathExtras.h>
34 #include <wtf/PassRefPtr.h>
35
36 namespace WebCore {
37
38 class GraphicsContext;
39 class IntRect;
40 class PlatformMouseEvent;
41 class ScrollableArea;
42 class ScrollbarTheme;
43
44 class Scrollbar : public Widget,
45                   public ScrollbarThemeClient {
46
47 public:
48     // Must be implemented by platforms that can't simply use the Scrollbar base class.  Right now the only platform that is not using the base class is GTK.
49     static PassRefPtr<Scrollbar> createNativeScrollbar(ScrollableArea*, ScrollbarOrientation orientation, ScrollbarControlSize size);
50
51     virtual ~Scrollbar();
52
53     // ScrollbarThemeClient implementation.
54     virtual int x() const OVERRIDE { return Widget::x(); }
55     virtual int y() const OVERRIDE { return Widget::y(); }
56     virtual int width() const OVERRIDE { return Widget::width(); }
57     virtual int height() const OVERRIDE { return Widget::height(); }
58     virtual IntSize size() const OVERRIDE { return Widget::size(); }
59     virtual IntPoint location() const OVERRIDE { return Widget::location(); }
60
61     virtual ScrollView* parent() const OVERRIDE { return Widget::parent(); }
62     virtual ScrollView* root() const OVERRIDE { return Widget::root(); }
63
64     virtual void setFrameRect(const IntRect&) OVERRIDE;
65     virtual IntRect frameRect() const OVERRIDE { return Widget::frameRect(); }
66
67     virtual void invalidate() OVERRIDE { Widget::invalidate(); }
68     virtual void invalidateRect(const IntRect&) OVERRIDE;
69
70     virtual ScrollbarOverlayStyle scrollbarOverlayStyle() const OVERRIDE;
71     virtual bool isScrollableAreaActive() const OVERRIDE;
72     virtual bool isScrollViewScrollbar() const OVERRIDE;
73
74     virtual IntPoint convertFromContainingWindow(const IntPoint& windowPoint) OVERRIDE { return Widget::convertFromContainingWindow(windowPoint); }
75
76     virtual bool isCustomScrollbar() const OVERRIDE { return false; }
77     virtual ScrollbarOrientation orientation() const OVERRIDE { return m_orientation; }
78
79     virtual int value() const OVERRIDE { return lroundf(m_currentPos); }
80     virtual float currentPos() const OVERRIDE { return m_currentPos; }
81     virtual int visibleSize() const OVERRIDE { return m_visibleSize; }
82     virtual int totalSize() const OVERRIDE { return m_totalSize; }
83     virtual int maximum() const OVERRIDE { return m_totalSize - m_visibleSize; }
84     virtual ScrollbarControlSize controlSize() const OVERRIDE { return m_controlSize; }
85
86     virtual int lineStep() const OVERRIDE { return m_lineStep; }
87     virtual int pageStep() const OVERRIDE { return m_pageStep; }
88
89     virtual ScrollbarPart pressedPart() const OVERRIDE { return m_pressedPart; }
90     virtual ScrollbarPart hoveredPart() const OVERRIDE { return m_hoveredPart; }
91
92     virtual void styleChanged() OVERRIDE { }
93
94     virtual bool enabled() const OVERRIDE { return m_enabled; }
95     virtual void setEnabled(bool) OVERRIDE;
96
97     // Called by the ScrollableArea when the scroll offset changes.
98     void offsetDidChange();
99
100     static int pixelsPerLineStep() { return 40; }
101     static float minFractionToStepWhenPaging() { return 0.875f; }
102     static int maxOverlapBetweenPages();
103
104     void disconnectFromScrollableArea() { m_scrollableArea = 0; }
105     ScrollableArea* scrollableArea() const { return m_scrollableArea; }
106
107     int pressedPos() const { return m_pressedPos; }
108
109     float pixelStep() const { return m_pixelStep; }
110
111     virtual void setHoveredPart(ScrollbarPart);
112     virtual void setPressedPart(ScrollbarPart);
113
114     void setSteps(int lineStep, int pageStep, int pixelsPerStep = 1);
115     void setProportion(int visibleSize, int totalSize);
116     void setPressedPos(int p) { m_pressedPos = p; }
117
118     virtual void paint(GraphicsContext*, const IntRect& damageRect) OVERRIDE;
119
120     virtual bool isOverlayScrollbar() const OVERRIDE;
121     bool shouldParticipateInHitTesting();
122
123     bool isWindowActive() const;
124
125     // These methods are used for platform scrollbars to give :hover feedback.  They will not get called
126     // when the mouse went down in a scrollbar, since it is assumed the scrollbar will start
127     // grabbing all events in that case anyway.
128 #if !PLATFORM(IOS)
129     bool mouseMoved(const PlatformMouseEvent&);
130 #endif
131     void mouseEntered();
132     bool mouseExited();
133
134     // Used by some platform scrollbars to know when they've been released from capture.
135     bool mouseUp(const PlatformMouseEvent&);
136
137     bool mouseDown(const PlatformMouseEvent&);
138
139     ScrollbarTheme* theme() const { return m_theme; }
140
141     virtual void setParent(ScrollView*) OVERRIDE;
142
143     bool suppressInvalidation() const { return m_suppressInvalidation; }
144     void setSuppressInvalidation(bool s) { m_suppressInvalidation = s; }
145
146     virtual IntRect convertToContainingView(const IntRect&) const OVERRIDE;
147     virtual IntRect convertFromContainingView(const IntRect&) const OVERRIDE;
148
149     virtual IntPoint convertToContainingView(const IntPoint&) const OVERRIDE;
150     virtual IntPoint convertFromContainingView(const IntPoint&) const OVERRIDE;
151
152     void moveThumb(int pos, bool draggingDocument = false);
153
154     virtual bool isAlphaLocked() const OVERRIDE { return m_isAlphaLocked; }
155     virtual void setIsAlphaLocked(bool flag) OVERRIDE { m_isAlphaLocked = flag; }
156
157     virtual bool supportsUpdateOnSecondaryThread() const;
158
159 protected:
160     Scrollbar(ScrollableArea*, ScrollbarOrientation, ScrollbarControlSize, ScrollbarTheme* = 0);
161
162     void updateThumb();
163     virtual void updateThumbPosition();
164     virtual void updateThumbProportion();
165
166     void autoscrollTimerFired(Timer<Scrollbar>*);
167     void startTimerIfNeeded(double delay);
168     void stopTimerIfNeeded();
169     void autoscrollPressedPart(double delay);
170     ScrollDirection pressedPartScrollDirection();
171     ScrollGranularity pressedPartScrollGranularity();
172
173     ScrollableArea* m_scrollableArea;
174     ScrollbarOrientation m_orientation;
175     ScrollbarControlSize m_controlSize;
176     ScrollbarTheme* m_theme;
177
178     int m_visibleSize;
179     int m_totalSize;
180     float m_currentPos;
181     float m_dragOrigin;
182     int m_lineStep;
183     int m_pageStep;
184     float m_pixelStep;
185
186     ScrollbarPart m_hoveredPart;
187     ScrollbarPart m_pressedPart;
188     int m_pressedPos;
189     float m_scrollPos;
190     bool m_draggingDocument;
191     int m_documentDragPos;
192
193     bool m_enabled;
194
195     Timer<Scrollbar> m_scrollTimer;
196     bool m_overlapsResizer;
197
198     bool m_suppressInvalidation;
199
200     bool m_isAlphaLocked;
201
202 private:
203     virtual bool isScrollbar() const OVERRIDE { return true; }
204 };
205
206 WIDGET_TYPE_CASTS(Scrollbar, isScrollbar());
207
208 } // namespace WebCore
209
210 #endif // Scrollbar_h