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 INSIDE_BLINK
     33 #include "wtf/PassOwnPtr.h"
     34 #endif
     35 
     36 namespace blink {
     37 
     38 // A const accessor interface for a WebKit scrollbar
     39 class BLINK_PLATFORM_EXPORT WebScrollbar {
     40 public:
     41     enum Orientation {
     42         Horizontal,
     43         Vertical
     44     };
     45 
     46     enum ScrollDirection {
     47         ScrollBackward,
     48         ScrollForward
     49     };
     50 
     51     enum ScrollGranularity {
     52         ScrollByLine,
     53         ScrollByPage,
     54         ScrollByDocument,
     55         ScrollByPixel
     56     };
     57 
     58     enum ScrollbarControlSize {
     59         RegularScrollbar,
     60         SmallScrollbar
     61     };
     62 
     63     enum ScrollbarPart {
     64         NoPart = 0,
     65         BackButtonStartPart = 1,
     66         ForwardButtonStartPart = 1 << 1,
     67         BackTrackPart = 1 << 2,
     68         ThumbPart = 1 << 3,
     69         ForwardTrackPart = 1 << 4,
     70         BackButtonEndPart = 1 << 5,
     71         ForwardButtonEndPart = 1 << 6,
     72         ScrollbarBGPart = 1 << 7,
     73         TrackBGPart = 1 << 8,
     74         AllParts = 0xffffffff
     75     };
     76 
     77     enum ScrollbarOverlayStyle {
     78         ScrollbarOverlayStyleDefault,
     79         ScrollbarOverlayStyleDark,
     80         ScrollbarOverlayStyleLight
     81     };
     82 
     83     virtual ~WebScrollbar() { }
     84 
     85     // Return true if this is an overlay scrollbar.
     86     virtual bool isOverlay() const = 0;
     87 
     88     // Gets the current value (i.e. position inside the region).
     89     virtual int value() const = 0;
     90 
     91     virtual WebPoint location() const = 0;
     92     virtual WebSize size() const = 0;
     93     virtual bool enabled() const = 0;
     94     virtual int maximum() const = 0;
     95     virtual int totalSize() const = 0;
     96     virtual bool isScrollViewScrollbar() const = 0;
     97     virtual bool isScrollableAreaActive() const = 0;
     98     virtual void getTickmarks(WebVector<WebRect>& tickmarks) const = 0;
     99     virtual ScrollbarControlSize controlSize() const = 0;
    100     virtual ScrollbarPart pressedPart() const = 0;
    101     virtual ScrollbarPart hoveredPart() const = 0;
    102     virtual ScrollbarOverlayStyle scrollbarOverlayStyle() const = 0;
    103     virtual bool isCustomScrollbar() const = 0;
    104     virtual Orientation orientation() const = 0;
    105     virtual bool isLeftSideVerticalScrollbar() const = 0;
    106     virtual bool isAlphaLocked() const { return false; }
    107     virtual void setIsAlphaLocked(bool) { }
    108 };
    109 
    110 } // namespace blink
    111 
    112 #endif
    113