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