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