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