72f0639eb98aac55278401233833d55fbc593b13
[WebKit-https.git] / WebCore / platform / Scrollbar.cpp
1 /*
2  * Copyright (C) 2004, 2006, 2008 Apple 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 #include "config.h"
27 #include "Scrollbar.h"
28
29 #include "AccessibilityScrollbar.h"
30 #include "AXObjectCache.h"
31 #include "EventHandler.h"
32 #include "Frame.h"
33 #include "FrameView.h"
34 #include "GraphicsContext.h"
35 #include "PlatformMouseEvent.h"
36 #include "ScrollbarClient.h"
37 #include "ScrollbarTheme.h"
38
39 #include <algorithm>
40
41 using namespace std;
42
43 #if (PLATFORM(CHROMIUM) && (OS(LINUX) || OS(FREEBSD))) || PLATFORM(GTK)
44 // The position of the scrollbar thumb affects the appearance of the steppers, so
45 // when the thumb moves, we have to invalidate them for painting.
46 #define THUMB_POSITION_AFFECTS_BUTTONS
47 #endif
48
49 namespace WebCore {
50
51 #if !PLATFORM(EFL)
52 PassRefPtr<Scrollbar> Scrollbar::createNativeScrollbar(ScrollbarClient* client, ScrollbarOrientation orientation, ScrollbarControlSize size)
53 {
54     return adoptRef(new Scrollbar(client, orientation, size));
55 }
56 #endif
57
58 int Scrollbar::maxOverlapBetweenPages()
59 {
60     static int maxOverlapBetweenPages = ScrollbarTheme::nativeTheme()->maxOverlapBetweenPages();
61     return maxOverlapBetweenPages;
62 }
63
64 Scrollbar::Scrollbar(ScrollbarClient* client, ScrollbarOrientation orientation, ScrollbarControlSize controlSize,
65                      ScrollbarTheme* theme)
66     : m_client(client)
67     , m_orientation(orientation)
68     , m_controlSize(controlSize)
69     , m_theme(theme)
70     , m_visibleSize(0)
71     , m_totalSize(0)
72     , m_currentPos(0)
73     , m_dragOrigin(0)
74     , m_lineStep(0)
75     , m_pageStep(0)
76     , m_pixelStep(1)
77     , m_hoveredPart(NoPart)
78     , m_pressedPart(NoPart)
79     , m_pressedPos(0)
80     , m_enabled(true)
81     , m_scrollTimer(this, &Scrollbar::autoscrollTimerFired)
82     , m_overlapsResizer(false)
83     , m_suppressInvalidation(false)
84 {
85     if (!m_theme)
86         m_theme = ScrollbarTheme::nativeTheme();
87
88     m_theme->registerScrollbar(this);
89
90     // FIXME: This is ugly and would not be necessary if we fix cross-platform code to actually query for
91     // scrollbar thickness and use it when sizing scrollbars (rather than leaving one dimension of the scrollbar
92     // alone when sizing).
93     int thickness = m_theme->scrollbarThickness(controlSize);
94     Widget::setFrameRect(IntRect(0, 0, thickness, thickness));
95 }
96
97 Scrollbar::~Scrollbar()
98 {
99     stopTimerIfNeeded();
100     
101     m_theme->unregisterScrollbar(this);
102 }
103
104 bool Scrollbar::setValue(int v, ScrollSource source)
105 {
106     v = max(min(v, m_totalSize - m_visibleSize), 0);
107     if (value() == v)
108         return false; // Our value stayed the same.
109     setCurrentPos(v, source);
110     return true;
111 }
112
113 void Scrollbar::setProportion(int visibleSize, int totalSize)
114 {
115     if (visibleSize == m_visibleSize && totalSize == m_totalSize)
116         return;
117
118     m_visibleSize = visibleSize;
119     m_totalSize = totalSize;
120
121     updateThumbProportion();
122 }
123
124 void Scrollbar::setSteps(int lineStep, int pageStep, int pixelsPerStep)
125 {
126     m_lineStep = lineStep;
127     m_pageStep = pageStep;
128     m_pixelStep = 1.0f / pixelsPerStep;
129 }
130
131 bool Scrollbar::scroll(ScrollDirection direction, ScrollGranularity granularity, float multiplier)
132 {
133 #if HAVE(ACCESSIBILITY)
134     if (AXObjectCache::accessibilityEnabled()) {
135         if (parent() && parent()->isFrameView()) {
136             Document* document = static_cast<FrameView*>(parent())->frame()->document();
137             AXObjectCache* cache = document->axObjectCache();
138             AccessibilityScrollbar* axObject = static_cast<AccessibilityScrollbar*>(cache->getOrCreate(ScrollBarRole));
139             axObject->setScrollbar(this);
140             cache->postNotification(axObject, document, AXObjectCache::AXValueChanged, true);
141         }
142     }
143 #endif
144
145     // Ignore perpendicular scrolls.
146     if ((m_orientation == HorizontalScrollbar) ? (direction == ScrollUp || direction == ScrollDown) : (direction == ScrollLeft || direction == ScrollRight))
147         return false;
148     float step = 0;
149     switch (granularity) {
150     case ScrollByLine:     step = m_lineStep;  break;
151     case ScrollByPage:     step = m_pageStep;  break;
152     case ScrollByDocument: step = m_totalSize; break;
153     case ScrollByPixel:    step = m_pixelStep; break;
154     }
155     if (direction == ScrollUp || direction == ScrollLeft)
156         multiplier = -multiplier;
157     if (client())
158         return client()->scroll(m_orientation, granularity, step, multiplier);
159
160     return setCurrentPos(max(min(m_currentPos + (step * multiplier), static_cast<float>(m_totalSize - m_visibleSize)), 0.0f), NotFromScrollAnimator);
161 }
162
163 void Scrollbar::updateThumb()
164 {
165 #ifdef THUMB_POSITION_AFFECTS_BUTTONS
166     invalidate();
167 #else
168     theme()->invalidateParts(this, ForwardTrackPart | BackTrackPart | ThumbPart);
169 #endif
170 }
171
172 void Scrollbar::updateThumbPosition()
173 {
174     updateThumb();
175 }
176
177 void Scrollbar::updateThumbProportion()
178 {
179     updateThumb();
180 }
181
182 void Scrollbar::paint(GraphicsContext* context, const IntRect& damageRect)
183 {
184     if (context->updatingControlTints() && theme()->supportsControlTints()) {
185         invalidate();
186         return;
187     }
188
189     if (context->paintingDisabled() || !frameRect().intersects(damageRect))
190         return;
191
192     if (!theme()->paint(this, context, damageRect))
193         Widget::paint(context, damageRect);
194 }
195
196 void Scrollbar::autoscrollTimerFired(Timer<Scrollbar>*)
197 {
198     autoscrollPressedPart(theme()->autoscrollTimerDelay());
199 }
200
201 static bool thumbUnderMouse(Scrollbar* scrollbar)
202 {
203     int thumbPos = scrollbar->theme()->trackPosition(scrollbar) + scrollbar->theme()->thumbPosition(scrollbar);
204     int thumbLength = scrollbar->theme()->thumbLength(scrollbar);
205     return scrollbar->pressedPos() >= thumbPos && scrollbar->pressedPos() < thumbPos + thumbLength;
206 }
207
208 void Scrollbar::autoscrollPressedPart(double delay)
209 {
210     // Don't do anything for the thumb or if nothing was pressed.
211     if (m_pressedPart == ThumbPart || m_pressedPart == NoPart)
212         return;
213
214     // Handle the track.
215     if ((m_pressedPart == BackTrackPart || m_pressedPart == ForwardTrackPart) && thumbUnderMouse(this)) {
216         theme()->invalidatePart(this, m_pressedPart);
217         setHoveredPart(ThumbPart);
218         return;
219     }
220
221     // Handle the arrows and track.
222     if (scroll(pressedPartScrollDirection(), pressedPartScrollGranularity()))
223         startTimerIfNeeded(delay);
224 }
225
226 void Scrollbar::startTimerIfNeeded(double delay)
227 {
228     // Don't do anything for the thumb.
229     if (m_pressedPart == ThumbPart)
230         return;
231
232     // Handle the track.  We halt track scrolling once the thumb is level
233     // with us.
234     if ((m_pressedPart == BackTrackPart || m_pressedPart == ForwardTrackPart) && thumbUnderMouse(this)) {
235         theme()->invalidatePart(this, m_pressedPart);
236         setHoveredPart(ThumbPart);
237         return;
238     }
239
240     // We can't scroll if we've hit the beginning or end.
241     ScrollDirection dir = pressedPartScrollDirection();
242     if (dir == ScrollUp || dir == ScrollLeft) {
243         if (m_currentPos == 0)
244             return;
245     } else {
246         if (m_currentPos == maximum())
247             return;
248     }
249
250     m_scrollTimer.startOneShot(delay);
251 }
252
253 void Scrollbar::stopTimerIfNeeded()
254 {
255     if (m_scrollTimer.isActive())
256         m_scrollTimer.stop();
257 }
258
259 ScrollDirection Scrollbar::pressedPartScrollDirection()
260 {
261     if (m_orientation == HorizontalScrollbar) {
262         if (m_pressedPart == BackButtonStartPart || m_pressedPart == BackButtonEndPart || m_pressedPart == BackTrackPart)
263             return ScrollLeft;
264         return ScrollRight;
265     } else {
266         if (m_pressedPart == BackButtonStartPart || m_pressedPart == BackButtonEndPart || m_pressedPart == BackTrackPart)
267             return ScrollUp;
268         return ScrollDown;
269     }
270 }
271
272 ScrollGranularity Scrollbar::pressedPartScrollGranularity()
273 {
274     if (m_pressedPart == BackButtonStartPart || m_pressedPart == BackButtonEndPart ||  m_pressedPart == ForwardButtonStartPart || m_pressedPart == ForwardButtonEndPart)
275         return ScrollByLine;
276     return ScrollByPage;
277 }
278
279 void Scrollbar::moveThumb(int pos)
280 {
281     // Drag the thumb.
282     int thumbPos = theme()->thumbPosition(this);
283     int thumbLen = theme()->thumbLength(this);
284     int trackLen = theme()->trackLength(this);
285     int maxPos = trackLen - thumbLen;
286     int delta = pos - m_pressedPos;
287     if (delta > 0)
288         delta = min(maxPos - thumbPos, delta);
289     else if (delta < 0)
290         delta = max(-thumbPos, delta);
291     if (delta)
292         setCurrentPos(static_cast<float>(thumbPos + delta) * maximum() / (trackLen - thumbLen), NotFromScrollAnimator);
293 }
294
295 bool Scrollbar::setCurrentPos(float pos, ScrollSource source)
296 {
297     if ((source != FromScrollAnimator) && client())
298         client()->setScrollPositionAndStopAnimation(m_orientation, pos);
299
300     if (pos == m_currentPos)
301         return false;
302
303     int oldValue = value();
304     int oldThumbPos = theme()->thumbPosition(this);
305     m_currentPos = pos;
306     updateThumbPosition();
307     if (m_pressedPart == ThumbPart)
308         setPressedPos(m_pressedPos + theme()->thumbPosition(this) - oldThumbPos);
309
310     if (value() != oldValue && client())
311         client()->valueChanged(this);
312     return true;
313 }
314
315 void Scrollbar::setHoveredPart(ScrollbarPart part)
316 {
317     if (part == m_hoveredPart)
318         return;
319
320     if ((m_hoveredPart == NoPart || part == NoPart) && theme()->invalidateOnMouseEnterExit())
321         invalidate();  // Just invalidate the whole scrollbar, since the buttons at either end change anyway.
322     else if (m_pressedPart == NoPart) {  // When there's a pressed part, we don't draw a hovered state, so there's no reason to invalidate.
323         theme()->invalidatePart(this, part);
324         theme()->invalidatePart(this, m_hoveredPart);
325     }
326     m_hoveredPart = part;
327 }
328
329 void Scrollbar::setPressedPart(ScrollbarPart part)
330 {
331     if (m_pressedPart != NoPart)
332         theme()->invalidatePart(this, m_pressedPart);
333     m_pressedPart = part;
334     if (m_pressedPart != NoPart)
335         theme()->invalidatePart(this, m_pressedPart);
336     else if (m_hoveredPart != NoPart)  // When we no longer have a pressed part, we can start drawing a hovered state on the hovered part.
337         theme()->invalidatePart(this, m_hoveredPart);
338 }
339
340 bool Scrollbar::mouseMoved(const PlatformMouseEvent& evt)
341 {
342     if (m_pressedPart == ThumbPart) {
343         if (theme()->shouldSnapBackToDragOrigin(this, evt))
344             setCurrentPos(m_dragOrigin, NotFromScrollAnimator);
345         else {
346             moveThumb(m_orientation == HorizontalScrollbar ? 
347                       convertFromContainingWindow(evt.pos()).x() :
348                       convertFromContainingWindow(evt.pos()).y());
349         }
350         return true;
351     }
352
353     if (m_pressedPart != NoPart)
354         m_pressedPos = (orientation() == HorizontalScrollbar ? convertFromContainingWindow(evt.pos()).x() : convertFromContainingWindow(evt.pos()).y());
355
356     ScrollbarPart part = theme()->hitTest(this, evt);    
357     if (part != m_hoveredPart) {
358         if (m_pressedPart != NoPart) {
359             if (part == m_pressedPart) {
360                 // The mouse is moving back over the pressed part.  We
361                 // need to start up the timer action again.
362                 startTimerIfNeeded(theme()->autoscrollTimerDelay());
363                 theme()->invalidatePart(this, m_pressedPart);
364             } else if (m_hoveredPart == m_pressedPart) {
365                 // The mouse is leaving the pressed part.  Kill our timer
366                 // if needed.
367                 stopTimerIfNeeded();
368                 theme()->invalidatePart(this, m_pressedPart);
369             }
370         } 
371         
372         setHoveredPart(part);
373     } 
374
375     return true;
376 }
377
378 bool Scrollbar::mouseExited()
379 {
380     setHoveredPart(NoPart);
381     return true;
382 }
383
384 bool Scrollbar::mouseUp()
385 {
386     setPressedPart(NoPart);
387     m_pressedPos = 0;
388     stopTimerIfNeeded();
389
390     if (parent() && parent()->isFrameView())
391         static_cast<FrameView*>(parent())->frame()->eventHandler()->setMousePressed(false);
392
393     return true;
394 }
395
396 bool Scrollbar::mouseDown(const PlatformMouseEvent& evt)
397 {
398     // Early exit for right click
399     if (evt.button() == RightButton)
400         return true; // FIXME: Handled as context menu by Qt right now.  Should just avoid even calling this method on a right click though.
401
402     setPressedPart(theme()->hitTest(this, evt));
403     int pressedPos = (orientation() == HorizontalScrollbar ? convertFromContainingWindow(evt.pos()).x() : convertFromContainingWindow(evt.pos()).y());
404     
405     if ((m_pressedPart == BackTrackPart || m_pressedPart == ForwardTrackPart) && theme()->shouldCenterOnThumb(this, evt)) {
406         setHoveredPart(ThumbPart);
407         setPressedPart(ThumbPart);
408         m_dragOrigin = m_currentPos;
409         int thumbLen = theme()->thumbLength(this);
410         int desiredPos = pressedPos;
411         // Set the pressed position to the middle of the thumb so that when we do the move, the delta
412         // will be from the current pixel position of the thumb to the new desired position for the thumb.
413         m_pressedPos = theme()->trackPosition(this) + theme()->thumbPosition(this) + thumbLen / 2;
414         moveThumb(desiredPos);
415         return true;
416     } else if (m_pressedPart == ThumbPart)
417         m_dragOrigin = m_currentPos;
418     
419     m_pressedPos = pressedPos;
420
421     autoscrollPressedPart(theme()->initialAutoscrollTimerDelay());
422     return true;
423 }
424
425 void Scrollbar::setFrameRect(const IntRect& rect)
426 {
427     // Get our window resizer rect and see if we overlap.  Adjust to avoid the overlap
428     // if necessary.
429     IntRect adjustedRect(rect);
430     bool overlapsResizer = false;
431     ScrollView* view = parent();
432     if (view && !rect.isEmpty() && !view->windowResizerRect().isEmpty()) {
433         IntRect resizerRect = view->convertFromContainingWindow(view->windowResizerRect());
434         if (rect.intersects(resizerRect)) {
435             if (orientation() == HorizontalScrollbar) {
436                 int overlap = rect.right() - resizerRect.x();
437                 if (overlap > 0 && resizerRect.right() >= rect.right()) {
438                     adjustedRect.setWidth(rect.width() - overlap);
439                     overlapsResizer = true;
440                 }
441             } else {
442                 int overlap = rect.bottom() - resizerRect.y();
443                 if (overlap > 0 && resizerRect.bottom() >= rect.bottom()) {
444                     adjustedRect.setHeight(rect.height() - overlap);
445                     overlapsResizer = true;
446                 }
447             }
448         }
449     }
450     if (overlapsResizer != m_overlapsResizer) {
451         m_overlapsResizer = overlapsResizer;
452         if (view)
453             view->adjustScrollbarsAvoidingResizerCount(m_overlapsResizer ? 1 : -1);
454     }
455
456     Widget::setFrameRect(adjustedRect);
457 }
458
459 void Scrollbar::setParent(ScrollView* parentView)
460 {
461     if (!parentView && m_overlapsResizer && parent())
462         parent()->adjustScrollbarsAvoidingResizerCount(-1);
463     Widget::setParent(parentView);
464 }
465
466 void Scrollbar::setEnabled(bool e)
467
468     if (m_enabled == e)
469         return;
470     m_enabled = e;
471     invalidate();
472 }
473
474 bool Scrollbar::isWindowActive() const
475 {
476     return m_client && m_client->isActive();
477 }
478  
479 void Scrollbar::invalidateRect(const IntRect& rect)
480 {
481     if (suppressInvalidation())
482         return;
483     if (m_client)
484         m_client->invalidateScrollbarRect(this, rect);
485 }
486
487 IntRect Scrollbar::convertToContainingView(const IntRect& localRect) const
488 {
489     if (m_client)
490         return m_client->convertFromScrollbarToContainingView(this, localRect);
491
492     return Widget::convertToContainingView(localRect);
493 }
494
495 IntRect Scrollbar::convertFromContainingView(const IntRect& parentRect) const
496 {
497     if (m_client)
498         return m_client->convertFromContainingViewToScrollbar(this, parentRect);
499
500     return Widget::convertFromContainingView(parentRect);
501 }
502
503 IntPoint Scrollbar::convertToContainingView(const IntPoint& localPoint) const
504 {
505     if (m_client)
506         return m_client->convertFromScrollbarToContainingView(this, localPoint);
507
508     return Widget::convertToContainingView(localPoint);
509 }
510
511 IntPoint Scrollbar::convertFromContainingView(const IntPoint& parentPoint) const
512 {
513     if (m_client)
514         return m_client->convertFromContainingViewToScrollbar(this, parentPoint);
515
516     return Widget::convertFromContainingView(parentPoint);
517 }
518
519 }