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