Unreviewed, rolling out r126169.
[WebKit-https.git] / Source / 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 "IntRect.h"
31 #include <wtf/Forward.h>
32 #include <wtf/RefCounted.h>
33
34 #if PLATFORM(CHROMIUM)
35 #include "PlatformWidget.h"
36 #endif
37
38 #if PLATFORM(MAC)
39 #include <wtf/RetainPtr.h>
40 #endif
41
42 #if PLATFORM(QT)
43 #include <QPointer>
44 #include <qglobal.h>
45 #endif
46
47 #if PLATFORM(MAC)
48 OBJC_CLASS NSView;
49 OBJC_CLASS NSWindow;
50 typedef NSView *PlatformWidget;
51 #endif
52
53 #if PLATFORM(WIN)
54 typedef struct HWND__* HWND;
55 typedef HWND PlatformWidget;
56 #endif
57
58 #if PLATFORM(GTK)
59 typedef struct _GtkWidget GtkWidget;
60 typedef struct _GtkContainer GtkContainer;
61 typedef GtkWidget* PlatformWidget;
62 #endif
63
64 #if PLATFORM(QT)
65 QT_BEGIN_NAMESPACE
66 class QObject;
67 QT_END_NAMESPACE
68 typedef QObject* PlatformWidget;
69 #endif
70
71 #if PLATFORM(BLACKBERRY)
72 typedef void* PlatformWidget;
73 #endif
74
75 #if PLATFORM(WX)
76 class wxWindow;
77 typedef wxWindow* PlatformWidget;
78 #endif
79
80 #if PLATFORM(EFL)
81 typedef struct _Evas_Object Evas_Object;
82 typedef struct _Evas Evas;
83 typedef struct _Ecore_Evas Ecore_Evas;
84 typedef Evas_Object* PlatformWidget;
85 #endif
86
87 #if PLATFORM(QT)
88 class QWebPageClient;
89 typedef QWebPageClient* PlatformPageClient;
90 #elif PLATFORM(BLACKBERRY)
91 #include "PageClientBlackBerry.h"
92 typedef PageClientBlackBerry* PlatformPageClient;
93 #elif PLATFORM(EFL)
94 class PageClientEfl;
95 typedef PageClientEfl* PlatformPageClient;
96 #else
97 typedef PlatformWidget PlatformPageClient;
98 #endif
99
100 namespace WebCore {
101
102 class AXObjectCache;
103 class Cursor;
104 class Event;
105 class Font;
106 class GraphicsContext;
107 class PlatformMouseEvent;
108 class ScrollView;
109 class WidgetPrivate;
110
111 enum WidgetNotification { WillPaintFlattened, DidPaintFlattened };
112
113 // The Widget class serves as a base class for three kinds of objects:
114 // (1) Scrollable areas (ScrollView)
115 // (2) Scrollbars (Scrollbar)
116 // (3) Plugins (PluginView)
117 //
118 // A widget may or may not be backed by a platform-specific object (e.g., HWND on Windows, NSView on Mac, QWidget on Qt).
119 //
120 // Widgets are connected in a hierarchy, with the restriction that plugins and scrollbars are always leaves of the
121 // tree.  Only ScrollViews can have children (and therefore the Widget class has no concept of children).
122 //
123 // The rules right now for which widgets get platform-specific objects are as follows:
124 // ScrollView - Mac
125 // Scrollbar - Mac, Gtk
126 // Plugin - Mac, Windows (windowed only), Qt (windowed only, widget is an HWND on windows), Gtk (windowed only)
127 //
128 class Widget : public RefCounted<Widget> {
129 public:
130     explicit Widget(PlatformWidget = 0);
131     virtual ~Widget();
132
133     PlatformWidget platformWidget() const;
134     void setPlatformWidget(PlatformWidget);
135
136     int x() const { return frameRect().x(); }
137     int y() const { return frameRect().y(); }
138     int width() const { return frameRect().width(); }
139     int height() const { return frameRect().height(); }
140     IntSize size() const { return frameRect().size(); }
141     IntPoint location() const { return frameRect().location(); }
142
143     virtual void setFrameRect(const IntRect&);
144     IntRect frameRect() const;
145     IntRect boundsRect() const { return IntRect(0, 0, width(),  height()); }
146
147     void resize(int w, int h) { setFrameRect(IntRect(x(), y(), w, h)); }
148     void resize(const IntSize& s) { setFrameRect(IntRect(location(), s)); }
149     void move(int x, int y) { setFrameRect(IntRect(x, y, width(), height())); }
150     void move(const IntPoint& p) { setFrameRect(IntRect(p, size())); }
151
152     virtual void paint(GraphicsContext*, const IntRect&);
153     void invalidate() { invalidateRect(boundsRect()); }
154     virtual void invalidateRect(const IntRect&) = 0;
155
156     virtual void setFocus(bool);
157
158     void setCursor(const Cursor&);
159
160     virtual void show();
161     virtual void hide();
162     bool isSelfVisible() const { return m_selfVisible; } // Whether or not we have been explicitly marked as visible or not.
163     bool isParentVisible() const { return m_parentVisible; } // Whether or not our parent is visible.
164     bool isVisible() const { return m_selfVisible && m_parentVisible; } // Whether or not we are actually visible.
165     virtual void setParentVisible(bool visible) { m_parentVisible = visible; }
166     void setSelfVisible(bool v) { m_selfVisible = v; }
167
168     void setIsSelected(bool);
169
170     virtual bool isFrameView() const { return false; }
171     virtual bool isPluginView() const { return false; }
172     // FIXME: The Mac plug-in code should inherit from PluginView. When this happens PluginViewBase and PluginView can become one class.
173     virtual bool isPluginViewBase() const { return false; }
174     virtual bool isScrollbar() const { return false; }
175
176     void removeFromParent();
177     virtual void setParent(ScrollView* view);
178     ScrollView* parent() const { return m_parent; }
179     ScrollView* root() const;
180
181     virtual void handleEvent(Event*) { }
182
183     virtual void notifyWidget(WidgetNotification) { }
184
185     IntRect convertToRootView(const IntRect&) const;
186     IntRect convertFromRootView(const IntRect&) const;
187
188     IntPoint convertToRootView(const IntPoint&) const;
189     IntPoint convertFromRootView(const IntPoint&) const;
190
191     // It is important for cross-platform code to realize that Mac has flipped coordinates.  Therefore any code
192     // that tries to convert the location of a rect using the point-based convertFromContainingWindow will end
193     // up with an inaccurate rect.  Always make sure to use the rect-based convertFromContainingWindow method
194     // when converting window rects.
195     IntRect convertToContainingWindow(const IntRect&) const;
196     IntRect convertFromContainingWindow(const IntRect&) const;
197
198     IntPoint convertToContainingWindow(const IntPoint&) const;
199     IntPoint convertFromContainingWindow(const IntPoint&) const;
200
201     virtual void frameRectsChanged();
202
203     // Notifies this widget that other widgets on the page have been repositioned.
204     virtual void widgetPositionsUpdated() {}
205
206     // Whether transforms affect the frame rect. FIXME: We get rid of this and have
207     // the frame rects be the same no matter what transforms are applied.
208     virtual bool transformsAffectFrameRect() { return true; }
209
210 #if PLATFORM(MAC)
211     NSView* getOuterView() const;
212
213     void removeFromSuperview();
214 #endif
215
216 #if PLATFORM(EFL)
217     // FIXME: These should really go to PlatformWidget. They're here currently since
218     // the EFL port considers that Evas_Object (a C object) is a PlatformWidget, but
219     // encapsulating that into a C++ class will make this header clean as it should be.
220     Evas* evas() const;
221
222     void setEvasObject(Evas_Object*);
223     Evas_Object* evasObject() const;
224 #endif
225
226 #if PLATFORM(CHROMIUM)
227     virtual bool isPluginContainer() const { return false; }
228 #endif
229
230 #if PLATFORM(QT)
231     QObject* bindingObject() const;
232     void setBindingObject(QObject*);
233 #endif
234
235     // Virtual methods to convert points to/from the containing ScrollView
236     virtual IntRect convertToContainingView(const IntRect&) const;
237     virtual IntRect convertFromContainingView(const IntRect&) const;
238     virtual IntPoint convertToContainingView(const IntPoint&) const;
239     virtual IntPoint convertFromContainingView(const IntPoint&) const;
240
241     // A means to access the AX cache when this object can get a pointer to it.
242     virtual AXObjectCache* axObjectCache() const { return 0; }
243     
244 private:
245     void init(PlatformWidget); // Must be called by all Widget constructors to initialize cross-platform data.
246
247     void releasePlatformWidget();
248     void retainPlatformWidget();
249
250     // These methods are used to convert from the root widget to the containing window,
251     // which has behavior that may differ between platforms (e.g. Mac uses flipped window coordinates).
252     static IntRect convertFromRootToContainingWindow(const Widget* rootWidget, const IntRect&);
253     static IntRect convertFromContainingWindowToRoot(const Widget* rootWidget, const IntRect&);
254
255     static IntPoint convertFromRootToContainingWindow(const Widget* rootWidget, const IntPoint&);
256     static IntPoint convertFromContainingWindowToRoot(const Widget* rootWidget, const IntPoint&);
257
258 private:
259     ScrollView* m_parent;
260 #if !PLATFORM(MAC)
261     PlatformWidget m_widget;
262 #else
263     RetainPtr<NSView> m_widget;
264 #endif
265     bool m_selfVisible;
266     bool m_parentVisible;
267
268     IntRect m_frame; // Not used when a native widget exists.
269
270 #if PLATFORM(MAC) || PLATFORM(EFL)
271     WidgetPrivate* m_data;
272 #endif
273
274 #if PLATFORM(QT)
275     QPointer<QObject> m_bindingObject;
276 #endif
277
278 };
279
280 #if !PLATFORM(MAC)
281
282 inline PlatformWidget Widget::platformWidget() const
283 {
284     return m_widget;
285 }
286
287 inline void Widget::setPlatformWidget(PlatformWidget widget)
288 {
289     if (widget != m_widget) {
290         releasePlatformWidget();
291         m_widget = widget;
292         retainPlatformWidget();
293     }
294 }
295
296 #endif
297
298 #if !PLATFORM(GTK)
299
300 inline void Widget::releasePlatformWidget()
301 {
302 }
303
304 inline void Widget::retainPlatformWidget()
305 {
306 }
307
308 #endif
309
310 } // namespace WebCore
311
312 #endif // Widget_h