2008-04-01 Holger Hans Peter Freyther <holger.freyther@trolltech.com>
[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 typedef QWidget* PlatformWidget;
56 #endif
57
58 #if PLATFORM(WX)
59 class wxWindow;
60 typedef wxWindow* PlatformWidget;
61 #endif
62
63 namespace WebCore {
64
65     class Cursor;
66     class Event;
67     class Font;
68     class GraphicsContext;
69     class IntPoint;
70     class IntRect;
71     class IntSize;
72     class PlatformMouseEvent;
73     class ScrollView;
74     class WidgetClient;
75     class WidgetPrivate;
76
77     class Widget {
78     public:
79         Widget();
80         virtual ~Widget();
81
82         virtual void setEnabled(bool);
83         virtual bool isEnabled() const;
84
85         int x() const;
86         int y() const;
87         int width() const;
88         int height() const;
89         IntSize size() const;
90         void resize(int, int);
91         void resize(const IntSize&);
92         IntPoint pos() const;
93         void move(int, int);
94         void move(const IntPoint&);
95
96         virtual void paint(GraphicsContext*, const IntRect&);
97         virtual void invalidate();
98         virtual void invalidateRect(const IntRect&);
99
100         virtual void setFrameGeometry(const IntRect&);
101         virtual IntRect frameGeometry() const;
102
103         virtual void setFocus();
104
105         void setCursor(const Cursor&);
106         Cursor cursor();
107
108         virtual void show();
109         virtual void hide();
110
111         void setIsSelected(bool);
112
113         void setClient(WidgetClient*);
114         WidgetClient* client() const;
115
116         virtual bool isFrameView() const;
117
118         virtual void removeFromParent();
119
120         // This method is used by plugins on all platforms to obtain a clip rect that includes clips set by WebCore,
121         // e.g., in overflow:auto sections.  The clip rects coordinates are in the containing window's coordinate space.
122         // This clip includes any clips that the widget itself sets up for its children.
123         virtual IntRect windowClipRect() const;
124
125         virtual void handleEvent(Event*) { }
126
127         void setContainingWindow(PlatformWidget);
128         PlatformWidget containingWindow() const;
129
130 #if PLATFORM(WIN)
131         virtual void setParent(ScrollView*);
132         ScrollView* parent() const;
133
134         virtual void attachToWindow() { }
135         virtual void detachFromWindow() { }
136
137         virtual void geometryChanged() const {};
138         
139         IntRect convertToContainingWindow(const IntRect&) const;
140         IntPoint convertToContainingWindow(const IntPoint&) const;
141         IntPoint convertFromContainingWindow(const IntPoint&) const;
142
143         virtual IntPoint convertChildToSelf(const Widget*, const IntPoint&) const;
144         virtual IntPoint convertSelfToChild(const Widget*, const IntPoint&) const;
145
146         bool suppressInvalidation() const;
147         void setSuppressInvalidation(bool);
148
149 #endif
150
151 #if PLATFORM(GTK)
152         virtual void setParent(ScrollView*);
153         ScrollView* parent() const;
154
155         virtual void geometryChanged() const;
156
157         IntRect convertToContainingWindow(const IntRect&) const;
158         IntPoint convertToContainingWindow(const IntPoint&) const;
159         IntPoint convertFromContainingWindow(const IntPoint&) const;
160
161         virtual IntPoint convertChildToSelf(const Widget*, const IntPoint&) const;
162         virtual IntPoint convertSelfToChild(const Widget*, const IntPoint&) const;
163
164         bool suppressInvalidation() const;
165         void setSuppressInvalidation(bool);
166
167         GtkWidget* gtkWidget() const;
168 protected:
169         void setGtkWidget(GtkWidget*);
170 #endif
171
172 #if PLATFORM(QT)
173         void setNativeWidget(QWidget *widget);
174         QWidget* nativeWidget() const;
175
176         virtual void setParent(ScrollView*);
177         ScrollView* parent() const;
178         virtual void geometryChanged() const;
179         ScrollView* topLevel() const;
180
181         IntRect convertToContainingWindow(const IntRect&) const;
182         IntPoint convertToContainingWindow(const IntPoint&) const;
183         IntPoint convertFromContainingWindow(const IntPoint&) const;
184
185         virtual IntPoint convertChildToSelf(const Widget*, const IntPoint&) const;
186         virtual IntPoint convertSelfToChild(const Widget*, const IntPoint&) const;
187
188         bool suppressInvalidation() const;
189         void setSuppressInvalidation(bool);
190 #endif
191
192 #if PLATFORM(MAC)
193         Widget(NSView*);
194
195         NSView* getView() const;
196         NSView* getOuterView() const;
197         void setView(NSView*);
198         
199         static void beforeMouseDown(NSView*, Widget*);
200         static void afterMouseDown(NSView*, Widget*);
201
202         void addToSuperview(NSView* superview);
203         void removeFromSuperview();
204         IntPoint convertToScreenCoordinate(NSView*, const IntPoint&);
205 #endif
206
207 #if PLATFORM(WX)
208         Widget(wxWindow*);
209         wxWindow* nativeWindow() const;
210         virtual void setNativeWindow(wxWindow*);
211 #endif
212
213     private:
214         WidgetPrivate* data;
215     };
216
217 } // namespace WebCore
218
219 #endif // Widget_h