WebCore/platform/ScrollBar.cpp

   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 #include "config.h"
  27 #include "ScrollBar.h"
  28
  29 namespace WebCore {
  30
  31 Scrollbar::Scrollbar(ScrollbarClient* client, ScrollbarOrientation orientation, ScrollbarControlSize controlSize)
  32     : m_client(client)
  33     , m_orientation(orientation)
  34     , m_controlSize(controlSize)
  35     , m_visibleSize(0)
  36     , m_totalSize(0)
  37     , m_currentPos(0)
  38     , m_lineStep(0)
  39     , m_pageStep(0)
  40     , m_pixelStep(1)
  41 {
  42 }
  43
  44 bool Scrollbar::setValue(int v)
  45 {
  46     int maxPos = m_totalSize - m_visibleSize;
  47     if (v > maxPos)
  48         v = maxPos;
  49     if (v < 0)
  50         v = 0;
  51     if (value() == v)
  52         return false; // Our value stayed the same.
  53     m_currentPos = v;
  54
  55     updateThumbPosition();
  56
  57     if (client())
  58         client()->valueChanged(this);
  59
  60     return true;
  61 }
  62
  63 void Scrollbar::setProportion(int visibleSize, int totalSize)
  64 {
  65     if (visibleSize == m_visibleSize && totalSize == m_totalSize)
  66         return;
  67
  68     m_visibleSize = visibleSize;
  69     m_totalSize = totalSize;
  70
  71     updateThumbProportion();
  72 }
  73
  74 void Scrollbar::setSteps(int lineStep, int pageStep, int pixelsPerStep)
  75 {
  76     m_lineStep = lineStep;
  77     m_pageStep = pageStep;
  78     m_pixelStep = 1.0f / pixelsPerStep;
  79 }
  80
  81 bool Scrollbar::scroll(ScrollDirection direction, ScrollGranularity granularity, float multiplier)
  82 {
  83     float step = 0;
  84     if ((direction == ScrollUp && m_orientation == VerticalScrollbar) || (direction == ScrollLeft && m_orientation == HorizontalScrollbar))
  85         step = -1;
  86     else if ((direction == ScrollDown && m_orientation == VerticalScrollbar) || (direction == ScrollRight && m_orientation == HorizontalScrollbar))
  87         step = 1;
  88
  89     if (granularity == ScrollByLine)
  90         step *= m_lineStep;
  91     else if (granularity == ScrollByPage)
  92         step *= m_pageStep;
  93     else if (granularity == ScrollByDocument)
  94         step *= m_totalSize;
  95     else if (granularity == ScrollByPixel)
  96         step *= m_pixelStep;
  97
  98     float newPos = m_currentPos + step * multiplier;
  99     float maxPos = m_totalSize - m_visibleSize;
 100     if (newPos < 0)
 101         newPos = 0;
 102     if (newPos > maxPos)
 103         newPos = maxPos;
 104     if (newPos == m_currentPos)
 105         return false;
 106
 107     int oldValue = value();
 108     m_currentPos = newPos;
 109     updateThumbPosition();
 110
 111     if (value() != oldValue && client())
 112         client()->valueChanged(this);
 113
 114     // return true even if the integer value did not change so that scroll event gets eaten
 115     return true;
 116 }
 117 }