Source/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 "AXObjectCache.h"
  30 #include "AccessibilityScrollbar.h"
  31 #include "EventHandler.h"
  32 #include "Frame.h"
  33 #include "FrameView.h"
  34 #include "GraphicsContext.h"
  35 #include "PlatformMouseEvent.h"
  36 #include "ScrollableArea.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(ScrollableArea* scrollableArea, ScrollbarOrientation orientation, ScrollbarControlSize size)
  53 {
  54     return adoptRef(new Scrollbar(scrollableArea, 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(ScrollableArea* scrollableArea, ScrollbarOrientation orientation, ScrollbarControlSize controlSize,
  65                      ScrollbarTheme* theme)
  66     : m_scrollableArea(scrollableArea)
  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     if (AXObjectCache::accessibilityEnabled() && axObjectCache())
 100         axObjectCache()->remove(this);
 101
 102     stopTimerIfNeeded();
 103
 104     m_theme->unregisterScrollbar(this);
 105 }
 106
 107 void Scrollbar::offsetDidChange()
 108 {
 109     ASSERT(m_scrollableArea);
 110
 111     float position = static_cast<float>(m_scrollableArea->scrollPosition(this));
 112     if (position == m_currentPos)
 113         return;
 114
 115     int oldThumbPosition = theme()->thumbPosition(this);
 116     m_currentPos = position;
 117     updateThumbPosition();
 118     if (m_pressedPart == ThumbPart)
 119         setPressedPos(m_pressedPos + theme()->thumbPosition(this) - oldThumbPosition);
 120 }
 121
 122 void Scrollbar::setProportion(int visibleSize, int totalSize)
 123 {
 124     if (visibleSize == m_visibleSize && totalSize == m_totalSize)
 125         return;
 126
 127     m_visibleSize = visibleSize;
 128     m_totalSize = totalSize;
 129
 130     updateThumbProportion();
 131 }
 132
 133 void Scrollbar::setSteps(int lineStep, int pageStep, int pixelsPerStep)
 134 {
 135     m_lineStep = lineStep;
 136     m_pageStep = pageStep;
 137     m_pixelStep = 1.0f / pixelsPerStep;
 138 }
 139
 140 void Scrollbar::updateThumb()
 141 {
 142 #ifdef THUMB_POSITION_AFFECTS_BUTTONS
 143     invalidate();
 144 #else
 145     theme()->invalidateParts(this, ForwardTrackPart | BackTrackPart | ThumbPart);
 146 #endif
 147 }
 148
 149 void Scrollbar::updateThumbPosition()
 150 {
 151     updateThumb();
 152 }
 153
 154 void Scrollbar::updateThumbProportion()
 155 {
 156     updateThumb();
 157 }
 158
 159 void Scrollbar::paint(GraphicsContext* context, const IntRect& damageRect)
 160 {
 161     if (context->updatingControlTints() && theme()->supportsControlTints()) {
 162         invalidate();
 163         return;
 164     }
 165
 166     if (context->paintingDisabled() || !frameRect().intersects(damageRect))
 167         return;
 168
 169     if (!theme()->paint(this, context, damageRect))
 170         Widget::paint(context, damageRect);
 171 }
 172
 173 void Scrollbar::autoscrollTimerFired(Timer<Scrollbar>*)
 174 {
 175     autoscrollPressedPart(theme()->autoscrollTimerDelay());
 176 }
 177
 178 static bool thumbUnderMouse(Scrollbar* scrollbar)
 179 {
 180     int thumbPos = scrollbar->theme()->trackPosition(scrollbar) + scrollbar->theme()->thumbPosition(scrollbar);
 181     int thumbLength = scrollbar->theme()->thumbLength(scrollbar);
 182     return scrollbar->pressedPos() >= thumbPos && scrollbar->pressedPos() < thumbPos + thumbLength;
 183 }
 184
 185 void Scrollbar::autoscrollPressedPart(double delay)
 186 {
 187     // Don't do anything for the thumb or if nothing was pressed.
 188     if (m_pressedPart == ThumbPart || m_pressedPart == NoPart)
 189         return;
 190
 191     // Handle the track.
 192     if ((m_pressedPart == BackTrackPart || m_pressedPart == ForwardTrackPart) && thumbUnderMouse(this)) {
 193         theme()->invalidatePart(this, m_pressedPart);
 194         setHoveredPart(ThumbPart);
 195         return;
 196     }
 197
 198     // Handle the arrows and track.
 199     if (scrollableArea()->scroll(pressedPartScrollDirection(), pressedPartScrollGranularity()))
 200         startTimerIfNeeded(delay);
 201 }
 202
 203 void Scrollbar::startTimerIfNeeded(double delay)
 204 {
 205     // Don't do anything for the thumb.
 206     if (m_pressedPart == ThumbPart)
 207         return;
 208
 209     // Handle the track.  We halt track scrolling once the thumb is level
 210     // with us.
 211     if ((m_pressedPart == BackTrackPart || m_pressedPart == ForwardTrackPart) && thumbUnderMouse(this)) {
 212         theme()->invalidatePart(this, m_pressedPart);
 213         setHoveredPart(ThumbPart);
 214         return;
 215     }
 216
 217     // We can't scroll if we've hit the beginning or end.
 218     ScrollDirection dir = pressedPartScrollDirection();
 219     if (dir == ScrollUp || dir == ScrollLeft) {
 220         if (m_currentPos == 0)
 221             return;
 222     } else {
 223         if (m_currentPos == maximum())
 224             return;
 225     }
 226
 227     m_scrollTimer.startOneShot(delay);
 228 }
 229
 230 void Scrollbar::stopTimerIfNeeded()
 231 {
 232     if (m_scrollTimer.isActive())
 233         m_scrollTimer.stop();
 234 }
 235
 236 ScrollDirection Scrollbar::pressedPartScrollDirection()
 237 {
 238     if (m_orientation == HorizontalScrollbar) {
 239         if (m_pressedPart == BackButtonStartPart || m_pressedPart == BackButtonEndPart || m_pressedPart == BackTrackPart)
 240             return ScrollLeft;
 241         return ScrollRight;
 242     } else {
 243         if (m_pressedPart == BackButtonStartPart || m_pressedPart == BackButtonEndPart || m_pressedPart == BackTrackPart)
 244             return ScrollUp;
 245         return ScrollDown;
 246     }
 247 }
 248
 249 ScrollGranularity Scrollbar::pressedPartScrollGranularity()
 250 {
 251     if (m_pressedPart == BackButtonStartPart || m_pressedPart == BackButtonEndPart ||  m_pressedPart == ForwardButtonStartPart || m_pressedPart == ForwardButtonEndPart)
 252         return ScrollByLine;
 253     return ScrollByPage;
 254 }
 255
 256 void Scrollbar::moveThumb(int pos)
 257 {
 258     // Drag the thumb.
 259     int thumbPos = theme()->thumbPosition(this);
 260     int thumbLen = theme()->thumbLength(this);
 261     int trackLen = theme()->trackLength(this);
 262     int maxPos = trackLen - thumbLen;
 263     int delta = pos - m_pressedPos;
 264     if (delta > 0)
 265         delta = min(maxPos - thumbPos, delta);
 266     else if (delta < 0)
 267         delta = max(-thumbPos, delta);
 268
 269     if (delta) {
 270         float newPosition = static_cast<float>(thumbPos + delta) * maximum() / (trackLen - thumbLen);
 271         scrollableArea()->scrollToOffsetWithoutAnimation(m_orientation, newPosition);
 272     }
 273 }
 274
 275 void Scrollbar::setHoveredPart(ScrollbarPart part)
 276 {
 277     if (part == m_hoveredPart)
 278         return;
 279
 280     if ((m_hoveredPart == NoPart || part == NoPart) && theme()->invalidateOnMouseEnterExit())
 281         invalidate();  // Just invalidate the whole scrollbar, since the buttons at either end change anyway.
 282     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.
 283         theme()->invalidatePart(this, part);
 284         theme()->invalidatePart(this, m_hoveredPart);
 285     }
 286     m_hoveredPart = part;
 287 }
 288
 289 void Scrollbar::setPressedPart(ScrollbarPart part)
 290 {
 291     if (m_pressedPart != NoPart)
 292         theme()->invalidatePart(this, m_pressedPart);
 293     m_pressedPart = part;
 294     if (m_pressedPart != NoPart)
 295         theme()->invalidatePart(this, m_pressedPart);
 296     else if (m_hoveredPart != NoPart)  // When we no longer have a pressed part, we can start drawing a hovered state on the hovered part.
 297         theme()->invalidatePart(this, m_hoveredPart);
 298 }
 299
 300 bool Scrollbar::mouseMoved(const PlatformMouseEvent& evt)
 301 {
 302     if (m_pressedPart == ThumbPart) {
 303         if (theme()->shouldSnapBackToDragOrigin(this, evt))
 304             scrollableArea()->scrollToOffsetWithoutAnimation(m_orientation, m_dragOrigin);
 305         else {
 306             moveThumb(m_orientation == HorizontalScrollbar ?
 307                       convertFromContainingWindow(evt.pos()).x() :
 308                       convertFromContainingWindow(evt.pos()).y());
 309         }
 310         return true;
 311     }
 312
 313     if (m_pressedPart != NoPart)
 314         m_pressedPos = (orientation() == HorizontalScrollbar ? convertFromContainingWindow(evt.pos()).x() : convertFromContainingWindow(evt.pos()).y());
 315
 316     ScrollbarPart part = theme()->hitTest(this, evt);
 317     if (part != m_hoveredPart) {
 318         if (m_pressedPart != NoPart) {
 319             if (part == m_pressedPart) {
 320                 // The mouse is moving back over the pressed part.  We
 321                 // need to start up the timer action again.
 322                 startTimerIfNeeded(theme()->autoscrollTimerDelay());
 323                 theme()->invalidatePart(this, m_pressedPart);
 324             } else if (m_hoveredPart == m_pressedPart) {
 325                 // The mouse is leaving the pressed part.  Kill our timer
 326                 // if needed.
 327                 stopTimerIfNeeded();
 328                 theme()->invalidatePart(this, m_pressedPart);
 329             }
 330         }
 331
 332         setHoveredPart(part);
 333     }
 334
 335     return true;
 336 }
 337
 338 bool Scrollbar::mouseExited()
 339 {
 340     setHoveredPart(NoPart);
 341     return true;
 342 }
 343
 344 bool Scrollbar::mouseUp()
 345 {
 346     setPressedPart(NoPart);
 347     m_pressedPos = 0;
 348     stopTimerIfNeeded();
 349
 350     if (parent() && parent()->isFrameView())
 351         static_cast<FrameView*>(parent())->frame()->eventHandler()->setMousePressed(false);
 352
 353     return true;
 354 }
 355
 356 bool Scrollbar::mouseDown(const PlatformMouseEvent& evt)
 357 {
 358     // Early exit for right click
 359     if (evt.button() == RightButton)
 360         return true; // FIXME: Handled as context menu by Qt right now.  Should just avoid even calling this method on a right click though.
 361
 362     setPressedPart(theme()->hitTest(this, evt));
 363     int pressedPos = (orientation() == HorizontalScrollbar ? convertFromContainingWindow(evt.pos()).x() : convertFromContainingWindow(evt.pos()).y());
 364
 365     if ((m_pressedPart == BackTrackPart || m_pressedPart == ForwardTrackPart) && theme()->shouldCenterOnThumb(this, evt)) {
 366         setHoveredPart(ThumbPart);
 367         setPressedPart(ThumbPart);
 368         m_dragOrigin = m_currentPos;
 369         int thumbLen = theme()->thumbLength(this);
 370         int desiredPos = pressedPos;
 371         // Set the pressed position to the middle of the thumb so that when we do the move, the delta
 372         // will be from the current pixel position of the thumb to the new desired position for the thumb.
 373         m_pressedPos = theme()->trackPosition(this) + theme()->thumbPosition(this) + thumbLen / 2;
 374         moveThumb(desiredPos);
 375         return true;
 376     } else if (m_pressedPart == ThumbPart)
 377         m_dragOrigin = m_currentPos;
 378
 379     m_pressedPos = pressedPos;
 380
 381     autoscrollPressedPart(theme()->initialAutoscrollTimerDelay());
 382     return true;
 383 }
 384
 385 void Scrollbar::setFrameRect(const IntRect& rect)
 386 {
 387     // Get our window resizer rect and see if we overlap.  Adjust to avoid the overlap
 388     // if necessary.
 389     IntRect adjustedRect(rect);
 390     bool overlapsResizer = false;
 391     ScrollView* view = parent();
 392     if (view && !rect.isEmpty() && !view->windowResizerRect().isEmpty()) {
 393         IntRect resizerRect = view->convertFromContainingWindow(view->windowResizerRect());
 394         if (rect.intersects(resizerRect)) {
 395             if (orientation() == HorizontalScrollbar) {
 396                 int overlap = rect.right() - resizerRect.x();
 397                 if (overlap > 0 && resizerRect.right() >= rect.right()) {
 398                     adjustedRect.setWidth(rect.width() - overlap);
 399                     overlapsResizer = true;
 400                 }
 401             } else {
 402                 int overlap = rect.bottom() - resizerRect.y();
 403                 if (overlap > 0 && resizerRect.bottom() >= rect.bottom()) {
 404                     adjustedRect.setHeight(rect.height() - overlap);
 405                     overlapsResizer = true;
 406                 }
 407             }
 408         }
 409     }
 410     if (overlapsResizer != m_overlapsResizer) {
 411         m_overlapsResizer = overlapsResizer;
 412         if (view)
 413             view->adjustScrollbarsAvoidingResizerCount(m_overlapsResizer ? 1 : -1);
 414     }
 415
 416     Widget::setFrameRect(adjustedRect);
 417 }
 418
 419 void Scrollbar::setParent(ScrollView* parentView)
 420 {
 421     if (!parentView && m_overlapsResizer && parent())
 422         parent()->adjustScrollbarsAvoidingResizerCount(-1);
 423     Widget::setParent(parentView);
 424 }
 425
 426 void Scrollbar::setEnabled(bool e)
 427 {
 428     if (m_enabled == e)
 429         return;
 430     m_enabled = e;
 431     invalidate();
 432 }
 433
 434 bool Scrollbar::isWindowActive() const
 435 {
 436     return m_scrollableArea && m_scrollableArea->isActive();
 437 }
 438
 439 AXObjectCache* Scrollbar::axObjectCache() const
 440 {
 441     if (!parent() || !parent()->isFrameView())
 442         return 0;
 443
 444     Document* document = static_cast<FrameView*>(parent())->frame()->document();
 445     return document->axObjectCache();
 446 }
 447
 448 void Scrollbar::invalidateRect(const IntRect& rect)
 449 {
 450     if (suppressInvalidation())
 451         return;
 452     if (m_scrollableArea)
 453         m_scrollableArea->invalidateScrollbarRect(this, rect);
 454 }
 455
 456 IntRect Scrollbar::convertToContainingView(const IntRect& localRect) const
 457 {
 458     if (m_scrollableArea)
 459         return m_scrollableArea->convertFromScrollbarToContainingView(this, localRect);
 460
 461     return Widget::convertToContainingView(localRect);
 462 }
 463
 464 IntRect Scrollbar::convertFromContainingView(const IntRect& parentRect) const
 465 {
 466     if (m_scrollableArea)
 467         return m_scrollableArea->convertFromContainingViewToScrollbar(this, parentRect);
 468
 469     return Widget::convertFromContainingView(parentRect);
 470 }
 471
 472 IntPoint Scrollbar::convertToContainingView(const IntPoint& localPoint) const
 473 {
 474     if (m_scrollableArea)
 475         return m_scrollableArea->convertFromScrollbarToContainingView(this, localPoint);
 476
 477     return Widget::convertToContainingView(localPoint);
 478 }
 479
 480 IntPoint Scrollbar::convertFromContainingView(const IntPoint& parentPoint) const
 481 {
 482     if (m_scrollableArea)
 483         return m_scrollableArea->convertFromContainingViewToScrollbar(this, parentPoint);
 484
 485     return Widget::convertFromContainingView(parentPoint);
 486 }
 487
 488 } // namespace WebCore