Get rid of Widget::setBoundsSize
[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(HAIKU)
82 class BView;
83 typedef BView* PlatformWidget;
84 #endif
85
86 #if PLATFORM(EFL)
87 typedef struct _Evas_Object Evas_Object;
88 typedef struct _Evas Evas;
89 typedef struct _Ecore_Evas Ecore_Evas;
90 typedef Evas_Object* PlatformWidget;
91 #endif
92
93 #if PLATFORM(QT)
94 class QWebPageClient;
95 typedef QWebPageClient* 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     Widget(PlatformWidget = 0);
131     virtual ~Widget();
132
133     PlatformWidget platformWidget() const;
134     void setPlatformWidget(PlatformWidget);
135
136 #if PLATFORM(HAIKU)
137     PlatformWidget topLevelPlatformWidget() const { return m_topLevelPlatformWidget; }
138     void setTopLevelPlatformWidget(PlatformWidget widget)
139     {
140         m_topLevelPlatformWidget = widget;
141     }
142 #endif
143
144     int x() const { return frameRect().x(); }
145     int y() const { return frameRect().y(); }
146     int width() const { return frameRect().width(); }
147     int height() const { return frameRect().height(); }
148     IntSize size() const { return frameRect().size(); }
149     IntPoint location() const { return frameRect().location(); }
150
151     virtual void setFrameRect(const IntRect&);
152     virtual IntRect frameRect() const;
153     IntRect boundsRect() const { return IntRect(0, 0, width(),  height()); }
154
155     void resize(int w, int h) { setFrameRect(IntRect(x(), y(), w, h)); }
156     void resize(const IntSize& s) { setFrameRect(IntRect(location(), s)); }
157     void move(int x, int y) { setFrameRect(IntRect(x, y, width(), height())); }
158     void move(const IntPoint& p) { setFrameRect(IntRect(p, size())); }
159
160     virtual void paint(GraphicsContext*, const IntRect&);
161     void invalidate() { invalidateRect(boundsRect()); }
162     virtual void invalidateRect(const IntRect&) = 0;
163
164     virtual void setFocus(bool);
165
166     void setCursor(const Cursor&);
167
168     virtual void show();
169     virtual void hide();
170     bool isSelfVisible() const { return m_selfVisible; } // Whether or not we have been explicitly marked as visible or not.
171     bool isParentVisible() const { return m_parentVisible; } // Whether or not our parent is visible.
172     bool isVisible() const { return m_selfVisible && m_parentVisible; } // Whether or not we are actually visible.
173     virtual void setParentVisible(bool visible) { m_parentVisible = visible; }
174     void setSelfVisible(bool v) { m_selfVisible = v; }
175
176     void setIsSelected(bool);
177
178     virtual bool isFrameView() const { return false; }
179     virtual bool isPluginView() const { return false; }
180     // FIXME: The Mac plug-in code should inherit from PluginView. When this happens PluginViewBase and PluginView can become one class.
181     virtual bool isPluginViewBase() const { return false; }
182     virtual bool isScrollbar() const { return false; }
183
184     void removeFromParent();
185     virtual void setParent(ScrollView* view);
186     ScrollView* parent() const { return m_parent; }
187     ScrollView* root() const;
188
189     virtual void handleEvent(Event*) { }
190
191     virtual void notifyWidget(WidgetNotification) { }
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 #if PLATFORM(MAC)
209     NSView* getOuterView() const;
210
211     void removeFromSuperview();
212 #endif
213
214 #if PLATFORM(EFL)
215     // FIXME: These should really go to PlatformWidget. They're here currently since
216     // the EFL port considers that Evas_Object (a C object) is a PlatformWidget, but
217     // encapsulating that into a C++ class will make this header clean as it should be.
218     Evas* evas() const;
219
220     void setEvasObject(Evas_Object*);
221     Evas_Object* evasObject() const;
222
223     const String edjeTheme() const;
224     void setEdjeTheme(const String &);
225     const String edjeThemeRecursive() const;
226 #endif
227
228 #if PLATFORM(CHROMIUM)
229     virtual bool isPluginContainer() const { return false; }
230 #endif
231
232 #if PLATFORM(QT)
233     QObject* bindingObject() const;
234     void setBindingObject(QObject*);
235 #endif
236
237     // Virtual methods to convert points to/from the containing ScrollView
238     virtual IntRect convertToContainingView(const IntRect&) const;
239     virtual IntRect convertFromContainingView(const IntRect&) const;
240     virtual IntPoint convertToContainingView(const IntPoint&) const;
241     virtual IntPoint convertFromContainingView(const IntPoint&) const;
242
243     // A means to access the AX cache when this object can get a pointer to it.
244     virtual AXObjectCache* axObjectCache() const { return 0; }
245     
246 private:
247     void init(PlatformWidget); // Must be called by all Widget constructors to initialize cross-platform data.
248
249     void releasePlatformWidget();
250     void retainPlatformWidget();
251
252     // These methods are used to convert from the root widget to the containing window,
253     // which has behavior that may differ between platforms (e.g. Mac uses flipped window coordinates).
254     static IntRect convertFromRootToContainingWindow(const Widget* rootWidget, const IntRect&);
255     static IntRect convertFromContainingWindowToRoot(const Widget* rootWidget, const IntRect&);
256
257     static IntPoint convertFromRootToContainingWindow(const Widget* rootWidget, const IntPoint&);
258     static IntPoint convertFromContainingWindowToRoot(const Widget* rootWidget, const IntPoint&);
259
260 private:
261     ScrollView* m_parent;
262 #if !PLATFORM(MAC)
263     PlatformWidget m_widget;
264 #else
265     RetainPtr<NSView> m_widget;
266 #endif
267     bool m_selfVisible;
268     bool m_parentVisible;
269
270     IntRect m_frame; // Not used when a native widget exists.
271
272 #if PLATFORM(EFL)
273     // FIXME: Please see the previous #if PLATFORM(EFL) block.
274     Ecore_Evas* ecoreEvas() const;
275
276     void applyFallbackCursor();
277     void applyCursor();
278 #endif
279
280 #if PLATFORM(MAC) || PLATFORM(EFL)
281     WidgetPrivate* m_data;
282 #endif
283
284 #if PLATFORM(QT)
285     QWeakPointer<QObject> m_bindingObject;
286 #endif
287
288 #if PLATFORM(HAIKU)
289     PlatformWidget m_topLevelPlatformWidget;
290 #endif
291 };
292
293 #if !PLATFORM(MAC)
294
295 inline PlatformWidget Widget::platformWidget() const
296 {
297     return m_widget;
298 }
299
300 inline void Widget::setPlatformWidget(PlatformWidget widget)
301 {
302     if (widget != m_widget) {
303         releasePlatformWidget();
304         m_widget = widget;
305         retainPlatformWidget();
306     }
307 }
308
309 #endif
310
311 #if !PLATFORM(GTK)
312
313 inline void Widget::releasePlatformWidget()
314 {
315 }
316
317 inline void Widget::retainPlatformWidget()
318 {
319 }
320
321 #endif
322
323 } // namespace WebCore
324
325 #endif // Widget_h