Home | History | Annotate | Download | only in platform 
      1 /*
      2  * Copyright (C) 2012 Google 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 INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
     14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
     17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
     20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     23  */
     24 
     25 #ifndef WebScrollbar_h
     26 #define WebScrollbar_h
     27 
     28 #include "WebPoint.h"
     29 #include "WebRect.h"
     30 #include "WebSize.h"
     31 #include "WebVector.h"
     32 #if WEBKIT_IMPLEMENTATION
     33 #include <wtf/PassOwnPtr.h>
     34 #endif
     35 
     36 namespace WebCore {
     37 class Scrollbar;
     38 }
     39 
     40 namespace WebKit {
     41 
     42 // A const accessor interface for a WebKit scrollbar
     43 class WebScrollbar {
     44 public:
     45     enum Orientation {
     46         Horizontal,
     47         Vertical
     48     };
     49 
     50     enum ScrollDirection {
     51         ScrollBackward,
     52         ScrollForward
     53     };
     54 
     55     enum ScrollGranularity {
     56         ScrollByLine,
     57         ScrollByPage,
     58         ScrollByDocument,
     59         ScrollByPixel
     60     };
     61 
     62     enum ScrollbarControlSize {
     63         RegularScrollbar,
     64         SmallScrollbar
     65     };
     66 
     67     enum ScrollbarPart {
     68         NoPart = 0,
     69         BackButtonStartPart = 1,
     70         ForwardButtonStartPart = 1 << 1,
     71         BackTrackPart = 1 << 2,
     72         ThumbPart = 1 << 3,
     73         ForwardTrackPart = 1 << 4,
     74         BackButtonEndPart = 1 << 5,
     75         ForwardButtonEndPart = 1 << 6,
     76         ScrollbarBGPart = 1 << 7,
     77         TrackBGPart = 1 << 8,
     78         AllParts = 0xffffffff
     79     };
     80 
     81     enum ScrollbarOverlayStyle {
     82         ScrollbarOverlayStyleDefault,
     83         ScrollbarOverlayStyleDark,
     84         ScrollbarOverlayStyleLight
     85     };
     86 
     87     virtual ~WebScrollbar() { }
     88 
     89     // Return true if this is an overlay scrollbar.
     90     virtual bool isOverlay() const = 0;
     91 
     92     // Gets the current value (i.e. position inside the region).
     93     virtual int value() const = 0;
     94 
     95     virtual WebPoint location() const = 0;
     96     virtual WebSize size() const = 0;
     97     virtual bool enabled() const = 0;
     98     virtual int maximum() const = 0;
     99     virtual int totalSize() const = 0;
    100     virtual bool isScrollViewScrollbar() const = 0;
    101     virtual bool isScrollableAreaActive() const = 0;
    102     virtual void getTickmarks(WebVector<WebRect>& tickmarks) const = 0;
    103     virtual ScrollbarControlSize controlSize() const = 0;
    104     virtual ScrollbarPart pressedPart() const = 0;
    105     virtual ScrollbarPart hoveredPart() const = 0;
    106     virtual ScrollbarOverlayStyle scrollbarOverlayStyle() const = 0;
    107     virtual bool isCustomScrollbar() const = 0;
    108     virtual Orientation orientation() const = 0;
    109     virtual bool isAlphaLocked() const { return false; }
    110     virtual void setIsAlphaLocked(bool) { }
    111 };
    112 
    113 } // namespace WebKit
    114 
    115 #endif
    116