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