WebCore:
[WebKit-https.git] / WebCore / platform / ScrollBar.h
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 #ifndef ScrollBar_h
27 #define ScrollBar_h
28
29 #include "Shared.h"
30 #include "ScrollTypes.h"
31
32 namespace WebCore {
33
34 class GraphicsContext;
35 class IntRect;
36 class Scrollbar;
37 class PlatformMouseEvent;
38
39 // These match the numbers we use over in WebKit (WebFrameView.m).
40 #define LINE_STEP   40
41 #define PAGE_KEEP   40
42
43 enum ScrollbarControlSize { RegularScrollbar, SmallScrollbar, MiniScrollbar };
44
45 class ScrollbarClient {
46 public:
47     virtual ~ScrollbarClient() {}
48     virtual void valueChanged(Scrollbar*) = 0;
49
50     // Used to obtain a window clip rect.
51     virtual IntRect windowClipRect() const = 0;
52 };
53
54 class Scrollbar : public Shared<Scrollbar> {
55 protected:
56     Scrollbar(ScrollbarClient*, ScrollbarOrientation, ScrollbarControlSize);
57
58 public:
59     virtual ~Scrollbar() {}
60
61     virtual bool isWidget() const = 0;
62
63     ScrollbarOrientation orientation() const { return m_orientation; }
64     int value() const { return lroundf(m_currentPos); } 
65     
66     ScrollbarControlSize controlSize() const { return m_controlSize; }
67
68     void setSteps(int lineStep, int pageStep, int pixelsPerStep = 1);
69     
70     bool setValue(int);
71     void setProportion(int visibleSize, int totalSize);
72
73     bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1.0);
74     
75     virtual int width() const = 0;
76     virtual int height() const = 0;
77     virtual void setRect(const IntRect&) = 0;
78     virtual void setEnabled(bool) = 0;
79     virtual void paint(GraphicsContext*, const IntRect& damageRect) = 0;
80
81     static bool hasPlatformScrollbars() {
82         // To use the platform's built-in scrollbars by default, return true.  We may
83         // support styled engine scrollbars someday, and some platforms may wish to not
84         // implement a platform scrollbar at all by default.  That's what this method is for.
85         return true;
86     }
87
88     // These methods are used for platform scrollbars to give :hover feedback.  They will not get called
89     // when the mouse went down in a scrollbar, since it is assumed the scrollbar will start
90     // grabbing all events in that case anyway.
91     virtual bool handleMouseMoveEvent(const PlatformMouseEvent&) { return false; }
92     virtual bool handleMouseOutEvent(const PlatformMouseEvent&) { return false; }
93
94 protected:
95     virtual void updateThumbPosition() = 0;
96     virtual void updateThumbProportion() = 0;
97
98     ScrollbarClient* client() const { return m_client; }
99
100     ScrollbarClient* m_client;
101     ScrollbarOrientation m_orientation;
102     ScrollbarControlSize m_controlSize;
103     int m_visibleSize;
104     int m_totalSize;
105     float m_currentPos;
106     int m_lineStep;
107     int m_pageStep;
108     float m_pixelStep;
109 };
110
111 }
112
113 #endif