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