Reviewed by Eric. Landed by rwlbuis.
[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
40     class ScrollView : public Widget {
41     public:
42         int visibleWidth() const;
43         int visibleHeight() const;
44         FloatRect visibleContentRect() const;
45         int contentsWidth() const;
46         int contentsHeight() const;
47         int contentsX() const;
48         int contentsY() const;
49         IntSize scrollOffset() const;
50         void scrollBy(int dx, int dy);
51         virtual void scrollPointRecursively(int dx, int dy);
52
53         virtual void setContentsPos(int x, int y);
54
55         virtual void setVScrollBarMode(ScrollBarMode);
56         virtual void setHScrollBarMode(ScrollBarMode);
57
58         // Set the mode for both scroll bars at once.
59         virtual void setScrollBarsMode(ScrollBarMode);
60
61         // This gives us a means of blocking painting on our scrollbars until the first layout has occurred.
62         void suppressScrollBars(bool suppressed, bool repaintOnUnsuppress = false);
63         
64         ScrollBarMode vScrollBarMode() const;
65         ScrollBarMode hScrollBarMode() const;
66
67         void addChild(Widget*, int x = 0, int y = 0);
68         void removeChild(Widget*);
69
70         virtual void resizeContents(int w, int h);
71         void updateContents(const IntRect&, bool now = false);
72
73         IntPoint contentsToViewport(const IntPoint&);
74         IntPoint viewportToContents(const IntPoint&);
75
76         void setStaticBackground(bool);
77
78         bool inWindow() const;
79
80 #if __APPLE__
81         NSView* getDocumentView() const;
82 #endif
83
84 #if PLATFORM(WIN)
85         ScrollView();
86         ~ScrollView();
87     private:
88         void updateScrollBars();
89         IntSize maximumScroll() const;
90         int updateScrollInfo(short type, int current, int max, int pageSize);
91         class ScrollViewPrivate;
92         ScrollViewPrivate* m_data;
93 #endif
94
95 #if PLATFORM(GDK)
96         void updateView(const IntRect&, bool now = false);
97         virtual void setDrawable(GdkDrawable* drawable);
98         virtual void setFrameGeometry(const IntRect&);
99         ScrollView();
100         ~ScrollView();
101     private:
102         void updateScrollBars();
103         IntSize maximumScroll() const;
104         int updateScrollInfo(short type, int current, int max, int pageSize);
105         class ScrollViewPrivate;
106         ScrollViewPrivate* m_data;
107 #endif
108
109 #if PLATFORM(QT)
110         ScrollView();
111         ~ScrollView();
112
113         virtual void setParentWidget(QWidget*);
114
115     private:
116         QScrollArea* m_area;
117 #endif
118     };
119
120 } // namespace WebCore
121
122 #endif // ScrollView_H