fd312c266cfb4e2319fefbf2767ed119b2e98548
[WebKit-https.git] / WebCore / platform / Widget.h
1 /*
2  * Copyright (C) 2004, 2005, 2006 Apple Computer, Inc.  All rights reserved.
3  * Copyright (C) 2008 Collabora Ltd.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef Widget_h
28 #define Widget_h
29
30 #include <wtf/Platform.h>
31
32 #if PLATFORM(MAC)
33 #ifdef __OBJC__
34 @class NSView;
35 #else
36 class NSView;
37 #endif
38 typedef NSView* PlatformWidget;
39 #endif
40
41 #if PLATFORM(WIN)
42 typedef struct HWND__* HWND;
43 typedef HWND PlatformWidget;
44 #endif
45
46 #if PLATFORM(GTK)
47 typedef struct _GdkDrawable GdkDrawable;
48 typedef struct _GtkWidget GtkWidget;
49 typedef struct _GtkContainer GtkContainer;
50 typedef GtkWidget* PlatformWidget;
51 #endif
52
53 #if PLATFORM(QT)
54 class QWidget;
55 class QWebFrame;
56 typedef QWidget* PlatformWidget;
57 #endif
58
59 #if PLATFORM(WX)
60 class wxWindow;
61 typedef wxWindow* PlatformWidget;
62 #endif
63
64 namespace WebCore {
65
66     class Cursor;
67     class Event;
68     class Font;
69     class GraphicsContext;
70     class IntPoint;
71     class IntRect;
72     class IntSize;
73     class PlatformMouseEvent;
74     class ScrollView;
75     class WidgetClient;
76     class WidgetPrivate;
77
78     class Widget {
79     public:
80         Widget();
81         virtual ~Widget();
82
83         virtual void setEnabled(bool);
84         virtual bool isEnabled() const;
85
86         int x() const;
87         int y() const;
88         int width() const;
89         int height() const;
90         IntSize size() const;
91         void resize(int, int);
92         void resize(const IntSize&);
93         IntPoint pos() const;
94         void move(int, int);
95         void move(const IntPoint&);
96
97         virtual void paint(GraphicsContext*, const IntRect&);
98         virtual void invalidate();
99         virtual void invalidateRect(const IntRect&);
100
101         virtual void setFrameGeometry(const IntRect&);
102         virtual IntRect frameGeometry() const;
103
104         virtual void setFocus();
105
106         void setCursor(const Cursor&);
107         Cursor cursor();
108
109         virtual void show();
110         virtual void hide();
111
112         void setIsSelected(bool);
113
114         void setClient(WidgetClient*);
115         WidgetClient* client() const;
116
117         virtual bool isFrameView() const;
118
119         virtual void removeFromParent();
120
121         // This method is used by plugins on all platforms to obtain a clip rect that includes clips set by WebCore,
122         // e.g., in overflow:auto sections.  The clip rects coordinates are in the containing window's coordinate space.
123         // This clip includes any clips that the widget itself sets up for its children.
124         virtual IntRect windowClipRect() const;
125
126         virtual void handleEvent(Event*) { }
127
128         void setContainingWindow(PlatformWidget);
129         PlatformWidget containingWindow() const;
130
131 #if PLATFORM(WIN)
132         virtual void setParent(ScrollView*);
133         ScrollView* parent() const;
134
135         virtual void attachToWindow() { }
136         virtual void detachFromWindow() { }
137
138         virtual void geometryChanged() const {};
139         
140         IntRect convertToContainingWindow(const IntRect&) const;
141         IntPoint convertToContainingWindow(const IntPoint&) const;
142         IntPoint convertFromContainingWindow(const IntPoint&) const;
143
144         virtual IntPoint convertChildToSelf(const Widget*, const IntPoint&) const;
145         virtual IntPoint convertSelfToChild(const Widget*, const IntPoint&) const;
146
147         bool suppressInvalidation() const;
148         void setSuppressInvalidation(bool);
149
150 #endif
151
152 #if PLATFORM(GTK)
153         virtual void setParent(ScrollView*);
154         ScrollView* parent() const;
155
156         virtual void geometryChanged() const;
157
158         IntRect convertToContainingWindow(const IntRect&) const;
159         IntPoint convertToContainingWindow(const IntPoint&) const;
160         IntPoint convertFromContainingWindow(const IntPoint&) const;
161
162         virtual IntPoint convertChildToSelf(const Widget*, const IntPoint&) const;
163         virtual IntPoint convertSelfToChild(const Widget*, const IntPoint&) const;
164
165         bool suppressInvalidation() const;
166         void setSuppressInvalidation(bool);
167
168         GtkWidget* gtkWidget() const;
169 protected:
170         void setGtkWidget(GtkWidget*);
171 #endif
172
173 #if PLATFORM(QT)
174         void setNativeWidget(QWidget *widget);
175         QWidget* nativeWidget() const;
176
177         QWebFrame* qwebframe() const;
178         void setQWebFrame(QWebFrame *webFrame);
179         virtual void setParent(ScrollView*);
180         ScrollView* parent() const;
181         virtual void geometryChanged() const;
182         ScrollView* topLevel() const;
183
184         IntRect convertToContainingWindow(const IntRect&) const;
185         IntPoint convertToContainingWindow(const IntPoint&) const;
186         IntPoint convertFromContainingWindow(const IntPoint&) const;
187
188         virtual IntPoint convertChildToSelf(const Widget*, const IntPoint&) const;
189         virtual IntPoint convertSelfToChild(const Widget*, const IntPoint&) const;
190
191         bool suppressInvalidation() const;
192         void setSuppressInvalidation(bool);
193 #endif
194
195 #if PLATFORM(MAC)
196         Widget(NSView*);
197
198         NSView* getView() const;
199         NSView* getOuterView() const;
200         void setView(NSView*);
201         
202         static void beforeMouseDown(NSView*, Widget*);
203         static void afterMouseDown(NSView*, Widget*);
204
205         void addToSuperview(NSView* superview);
206         void removeFromSuperview();
207         IntPoint convertToScreenCoordinate(NSView*, const IntPoint&);
208 #endif
209
210 #if PLATFORM(WX)
211         Widget(wxWindow*);
212         wxWindow* nativeWindow() const;
213         virtual void setNativeWindow(wxWindow*);
214 #endif
215
216     private:
217         WidgetPrivate* data;
218     };
219
220 } // namespace WebCore
221
222 #endif // Widget_h