2010-09-08 Peter Kasting <pkasting@google.com>
[WebKit-https.git] / 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 "ScrollTypes.h"
30 #include "Timer.h"
31 #include "Widget.h"
32 #include <wtf/MathExtras.h>
33 #include <wtf/PassRefPtr.h>
34
35 namespace WebCore {
36
37 class GraphicsContext;
38 class IntRect;
39 class ScrollbarClient;
40 class ScrollbarTheme;
41 class PlatformMouseEvent;
42
43 class Scrollbar : public Widget {
44 public:
45     enum ScrollSource {
46         FromScrollAnimator,
47         NotFromScrollAnimator,
48     };
49
50     virtual ~Scrollbar();
51
52     // 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.
53     static PassRefPtr<Scrollbar> createNativeScrollbar(ScrollbarClient* client, ScrollbarOrientation orientation, ScrollbarControlSize size);
54
55     static int pixelsPerLineStep() { return 40; }
56     static float minFractionToStepWhenPaging() { return 0.875f; }
57     static int maxOverlapBetweenPages();
58
59     void setClient(ScrollbarClient* client) { m_client = client; }
60     ScrollbarClient* client() const { return m_client; }
61
62     virtual bool isCustomScrollbar() const { return false; }
63     ScrollbarOrientation orientation() const { return m_orientation; }
64     
65     int value() const { return lroundf(m_currentPos); }
66     float currentPos() const { return m_currentPos; }
67     int pressedPos() const { return m_pressedPos; }
68     int visibleSize() const { return m_visibleSize; }
69     int totalSize() const { return m_totalSize; }
70     int maximum() const { return m_totalSize - m_visibleSize; }        
71     ScrollbarControlSize controlSize() const { return m_controlSize; }
72
73     int lineStep() const { return m_lineStep; }
74     int pageStep() const { return m_pageStep; }
75     float pixelStep() const { return m_pixelStep; }
76     
77     ScrollbarPart pressedPart() const { return m_pressedPart; }
78     ScrollbarPart hoveredPart() const { return m_hoveredPart; }
79     virtual void setHoveredPart(ScrollbarPart);
80     virtual void setPressedPart(ScrollbarPart);
81
82     void setSteps(int lineStep, int pageStep, int pixelsPerStep = 1);
83     bool setValue(int, ScrollSource source);
84     void setProportion(int visibleSize, int totalSize);
85     void setPressedPos(int p) { m_pressedPos = p; }
86
87     bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1);
88     
89     virtual void paint(GraphicsContext*, const IntRect& damageRect);
90
91     bool enabled() const { return m_enabled; }
92     virtual void setEnabled(bool e);
93
94     bool isWindowActive() const;
95
96     // These methods are used for platform scrollbars to give :hover feedback.  They will not get called
97     // when the mouse went down in a scrollbar, since it is assumed the scrollbar will start
98     // grabbing all events in that case anyway.
99     bool mouseMoved(const PlatformMouseEvent&);
100     bool mouseExited();
101     
102     // Used by some platform scrollbars to know when they've been released from capture.
103     bool mouseUp();
104
105     bool mouseDown(const PlatformMouseEvent&);
106
107 #if PLATFORM(QT)
108     // For platforms that wish to handle context menu events.
109     // FIXME: This is misplaced.  Normal hit testing should be used to populate a correct
110     // context menu.  There's no reason why the scrollbar should have to do it.
111     bool contextMenu(const PlatformMouseEvent& event);
112 #endif
113
114     ScrollbarTheme* theme() const { return m_theme; }
115
116     virtual void setParent(ScrollView*);
117     virtual void setFrameRect(const IntRect&);
118
119     virtual void invalidateRect(const IntRect&);
120     
121     bool suppressInvalidation() const { return m_suppressInvalidation; }
122     void setSuppressInvalidation(bool s) { m_suppressInvalidation = s; }
123
124     virtual void styleChanged() { }
125
126     virtual IntRect convertToContainingView(const IntRect&) const;
127     virtual IntRect convertFromContainingView(const IntRect&) const;
128     
129     virtual IntPoint convertToContainingView(const IntPoint&) const;
130     virtual IntPoint convertFromContainingView(const IntPoint&) const;
131
132 protected:
133     Scrollbar(ScrollbarClient*, ScrollbarOrientation, ScrollbarControlSize, ScrollbarTheme* = 0);
134
135     void updateThumb();
136     virtual void updateThumbPosition();
137     virtual void updateThumbProportion();
138
139     void autoscrollTimerFired(Timer<Scrollbar>*);
140     void startTimerIfNeeded(double delay);
141     void stopTimerIfNeeded();
142     void autoscrollPressedPart(double delay);
143     ScrollDirection pressedPartScrollDirection();
144     ScrollGranularity pressedPartScrollGranularity();
145     
146     void moveThumb(int pos);
147
148     ScrollbarClient* m_client;
149     ScrollbarOrientation m_orientation;
150     ScrollbarControlSize m_controlSize;
151     ScrollbarTheme* m_theme;
152     
153     int m_visibleSize;
154     int m_totalSize;
155     float m_currentPos;
156     float m_dragOrigin;
157     int m_lineStep;
158     int m_pageStep;
159     float m_pixelStep;
160
161     ScrollbarPart m_hoveredPart;
162     ScrollbarPart m_pressedPart;
163     int m_pressedPos;
164     
165     bool m_enabled;
166
167     Timer<Scrollbar> m_scrollTimer;
168     bool m_overlapsResizer;
169     
170     bool m_suppressInvalidation;
171
172 private:
173     virtual bool isScrollbar() const { return true; }
174
175     bool setCurrentPos(float pos, ScrollSource source);
176 };
177
178 }
179
180 #endif