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