Fix build bustage on many platforms by making sure the includes of ScrollBar stay...
[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 "IntRect.h"
30 #include "ScrollBarMode.h"
31 #include "ScrollBar.h"
32 #include "Widget.h"
33 #include <wtf/Platform.h>
34
35 #if PLATFORM(QT)
36 class QScrollArea;
37 #endif
38
39 namespace WebCore {
40     class FloatRect;
41     class PlatformWheelEvent;
42     class PlatformScrollbar;
43
44     class ScrollView : public Widget {
45     public:
46         int visibleWidth() const;
47         int visibleHeight() const;
48         FloatRect visibleContentRect() const;
49         int contentsWidth() const;
50         int contentsHeight() const;
51         int contentsX() const;
52         int contentsY() const;
53         IntSize scrollOffset() const;
54         void scrollBy(int dx, int dy);
55         virtual void scrollPointRecursively(int dx, int dy);
56
57         virtual void setContentsPos(int x, int y);
58
59         virtual void setVScrollbarMode(ScrollbarMode);
60         virtual void setHScrollbarMode(ScrollbarMode);
61
62         // Set the mode for both scrollbars at once.
63         virtual void setScrollbarsMode(ScrollbarMode);
64
65         // This gives us a means of blocking painting on our scrollbars until the first layout has occurred.
66         void suppressScrollbars(bool suppressed, bool repaintOnUnsuppress = false);
67         
68         ScrollbarMode vScrollbarMode() const;
69         ScrollbarMode hScrollbarMode() const;
70
71         void addChild(Widget*, int x = 0, int y = 0);
72         void removeChild(Widget*);
73
74         virtual void resizeContents(int w, int h);
75         void updateContents(const IntRect&, bool now = false);
76
77         // Event coordinates are assumed to be in the coordinate space of a window that contains
78         // the entire widget hierarchy.  It is up to the platform to decide what the precise definition
79         // of containing window is.  (For example on Mac it is the containing NSWindow.)
80         IntPoint windowToContents(const IntPoint&) const;
81         IntPoint contentsToWindow(const IntPoint&) const;
82  
83         void setStaticBackground(bool);
84
85         bool inWindow() const;
86
87         // For platforms that need to hit test scrollbars from within the engine's event handlers (like Win32).
88         PlatformScrollbar* scrollbarUnderMouse(const PlatformMouseEvent& mouseEvent);
89
90         // This method exists for scrollviews that need to handle wheel events manually.
91         // On Mac the underlying NSScrollView just does the scrolling, but on other platforms
92         // (like Windows), we need this method in order to do the scroll ourselves.
93         void wheelEvent(PlatformWheelEvent&);
94
95         void scroll(ScrollDirection, ScrollGranularity);
96
97 #if PLATFORM(MAC)
98         NSView* getDocumentView() const;
99 #endif
100
101 #if PLATFORM(WIN)
102         ScrollView();
103         ~ScrollView();
104
105         virtual void paint(GraphicsContext*, const IntRect&);
106         virtual void themeChanged();
107         
108         virtual IntPoint convertChildToSelf(const Widget*, const IntPoint&) const;
109         virtual IntPoint convertSelfToChild(const Widget*, const IntPoint&) const;
110         
111         virtual void scrolled() const;
112         virtual void setFrameGeometry(const IntRect&);
113         
114         virtual IntRect windowResizerRect();
115
116     private:
117         void updateScrollbars(const IntSize& desiredOffset);
118         IntSize maximumScroll() const;
119         class ScrollViewPrivate;
120         ScrollViewPrivate* m_data;
121 #endif
122
123 #if PLATFORM(GDK)
124         void updateView(const IntRect&, bool now = false);
125         virtual void setDrawable(GdkDrawable* drawable);
126         virtual void setFrameGeometry(const IntRect&);
127         ScrollView();
128         ~ScrollView();
129     private:
130         void updateScrollbars();
131         IntSize maximumScroll() const;
132         int updateScrollInfo(short type, int current, int max, int pageSize);
133         class ScrollViewPrivate;
134         ScrollViewPrivate* m_data;
135 #endif
136
137 #if PLATFORM(QT)
138         ScrollView();
139         ~ScrollView();
140
141         virtual void setParentWidget(QWidget*);
142
143     private:
144         QScrollArea* m_area;
145 #endif
146     };
147
148 } // namespace WebCore
149
150 #endif // ScrollView_H