Add a new wheelEvent method to ScrollView. Platforms that wish
[WebKit-https.git] / WebCore / platform / ScrollView.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 ScrollView_H
27 #define ScrollView_H
28
29 #include "ScrollBarMode.h"
30 #include "Widget.h"
31 #include <wtf/Platform.h>
32
33 #if PLATFORM(QT)
34 class QScrollArea;
35 #endif
36
37 namespace WebCore {
38     class FloatRect;
39     class PlatformWheelEvent;
40
41     class ScrollView : public Widget {
42     public:
43         int visibleWidth() const;
44         int visibleHeight() const;
45         FloatRect visibleContentRect() const;
46         int contentsWidth() const;
47         int contentsHeight() const;
48         int contentsX() const;
49         int contentsY() const;
50         IntSize scrollOffset() const;
51         void scrollBy(int dx, int dy);
52         virtual void scrollPointRecursively(int dx, int dy);
53
54         virtual void setContentsPos(int x, int y);
55
56         virtual void setVScrollBarMode(ScrollBarMode);
57         virtual void setHScrollBarMode(ScrollBarMode);
58
59         // Set the mode for both scroll bars at once.
60         virtual void setScrollBarsMode(ScrollBarMode);
61
62         // This gives us a means of blocking painting on our scrollbars until the first layout has occurred.
63         void suppressScrollBars(bool suppressed, bool repaintOnUnsuppress = false);
64         
65         ScrollBarMode vScrollBarMode() const;
66         ScrollBarMode hScrollBarMode() const;
67
68         void addChild(Widget*, int x = 0, int y = 0);
69         void removeChild(Widget*);
70
71         virtual void resizeContents(int w, int h);
72         void updateContents(const IntRect&, bool now = false);
73
74         IntPoint contentsToViewport(const IntPoint&);
75         IntPoint viewportToContents(const IntPoint&);
76
77         void setStaticBackground(bool);
78
79         bool inWindow() const;
80
81         // This method exists for scrollviews that need to handle wheel events manually.
82         // On Mac the underlying NSScrollView just does the scrolling, but on other platforms
83         // (like Windows), we need this method in order to do the scroll ourselves.
84         void wheelEvent(PlatformWheelEvent&) {};
85
86 #if __APPLE__
87         NSView* getDocumentView() const;
88 #endif
89
90 #if PLATFORM(WIN)
91         ScrollView();
92         ~ScrollView();
93     private:
94         void updateScrollBars();
95         IntSize maximumScroll() const;
96         int updateScrollInfo(short type, int current, int max, int pageSize);
97         class ScrollViewPrivate;
98         ScrollViewPrivate* m_data;
99 #endif
100
101 #if PLATFORM(GDK)
102         void updateView(const IntRect&, bool now = false);
103         virtual void setDrawable(GdkDrawable* drawable);
104         virtual void setFrameGeometry(const IntRect&);
105         ScrollView();
106         ~ScrollView();
107     private:
108         void updateScrollBars();
109         IntSize maximumScroll() const;
110         int updateScrollInfo(short type, int current, int max, int pageSize);
111         class ScrollViewPrivate;
112         ScrollViewPrivate* m_data;
113 #endif
114
115 #if PLATFORM(QT)
116         ScrollView();
117         ~ScrollView();
118
119         virtual void setParentWidget(QWidget*);
120
121     private:
122         QScrollArea* m_area;
123 #endif
124     };
125
126 } // namespace WebCore
127
128 #endif // ScrollView_H