[EFL] Build break with latest EFL 1.8 libraries.
[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 "PlatformScreen.h"
32 #include <wtf/Forward.h>
33 #include <wtf/RefCounted.h>
34
35 #if PLATFORM(MAC)
36 #include <wtf/RetainPtr.h>
37 #endif
38
39 #if PLATFORM(MAC)
40 OBJC_CLASS NSView;
41 OBJC_CLASS NSWindow;
42 typedef NSView *PlatformWidget;
43 #endif
44
45 #if PLATFORM(WIN)
46 typedef struct HWND__* HWND;
47 typedef HWND PlatformWidget;
48 #endif
49
50 #if PLATFORM(GTK)
51 typedef struct _GtkWidget GtkWidget;
52 typedef struct _GtkContainer GtkContainer;
53 typedef GtkWidget* PlatformWidget;
54 #endif
55
56 #if PLATFORM(BLACKBERRY) || PLATFORM(NIX)
57 typedef void* PlatformWidget;
58 #endif
59
60 #if PLATFORM(EFL)
61 #if USE(EO)
62 typedef struct _Eo_Opaque Evas_Object;
63 #else
64 typedef struct _Evas_Object Evas_Object;
65 #endif
66 typedef Evas_Object* PlatformWidget;
67 #endif
68
69 #if PLATFORM(BLACKBERRY)
70 #include "PageClientBlackBerry.h"
71 typedef PageClientBlackBerry* PlatformPageClient;
72 #elif PLATFORM(EFL)
73 class PageClientEfl;
74 typedef PageClientEfl* PlatformPageClient;
75 #else
76 typedef PlatformWidget PlatformPageClient;
77 #endif
78
79 namespace WebCore {
80
81 class Cursor;
82 class Event;
83 class Font;
84 class GraphicsContext;
85 class PlatformMouseEvent;
86 class ScrollView;
87
88 enum WidgetNotification { WillPaintFlattened, DidPaintFlattened };
89
90 // The Widget class serves as a base class for three kinds of objects:
91 // (1) Scrollable areas (ScrollView)
92 // (2) Scrollbars (Scrollbar)
93 // (3) Plugins (PluginView)
94 //
95 // A widget may or may not be backed by a platform-specific object (e.g., HWND on Windows, NSView on Mac, QWidget on Qt).
96 //
97 // Widgets are connected in a hierarchy, with the restriction that plugins and scrollbars are always leaves of the
98 // tree.  Only ScrollViews can have children (and therefore the Widget class has no concept of children).
99 //
100 // The rules right now for which widgets get platform-specific objects are as follows:
101 // ScrollView - Mac
102 // Scrollbar - Mac, Gtk
103 // Plugin - Mac, Windows (windowed only), Qt (windowed only, widget is an HWND on windows), Gtk (windowed only)
104 //
105 class Widget : public RefCounted<Widget> {
106 public:
107     explicit Widget(PlatformWidget = 0);
108     virtual ~Widget();
109
110     PlatformWidget platformWidget() const;
111     void setPlatformWidget(PlatformWidget);
112
113     int x() const { return frameRect().x(); }
114     int y() const { return frameRect().y(); }
115     int width() const { return frameRect().width(); }
116     int height() const { return frameRect().height(); }
117     IntSize size() const { return frameRect().size(); }
118     IntPoint location() const { return frameRect().location(); }
119
120     virtual void setFrameRect(const IntRect&);
121     IntRect frameRect() const;
122     IntRect boundsRect() const { return IntRect(0, 0, width(),  height()); }
123
124     void resize(int w, int h) { setFrameRect(IntRect(x(), y(), w, h)); }
125     void resize(const IntSize& s) { setFrameRect(IntRect(location(), s)); }
126     void move(int x, int y) { setFrameRect(IntRect(x, y, width(), height())); }
127     void move(const IntPoint& p) { setFrameRect(IntRect(p, size())); }
128
129     virtual void paint(GraphicsContext*, const IntRect&);
130     void invalidate() { invalidateRect(boundsRect()); }
131     virtual void invalidateRect(const IntRect&) = 0;
132
133     virtual void setFocus(bool);
134
135     void setCursor(const Cursor&);
136
137     virtual void show();
138     virtual void hide();
139     bool isSelfVisible() const { return m_selfVisible; } // Whether or not we have been explicitly marked as visible or not.
140     bool isParentVisible() const { return m_parentVisible; } // Whether or not our parent is visible.
141     bool isVisible() const { return m_selfVisible && m_parentVisible; } // Whether or not we are actually visible.
142     virtual void setParentVisible(bool visible) { m_parentVisible = visible; }
143     void setSelfVisible(bool v) { m_selfVisible = v; }
144
145     void setIsSelected(bool);
146
147     virtual bool isFrameView() const { return false; }
148     virtual bool isPluginView() const { return false; }
149     // FIXME: The Mac plug-in code should inherit from PluginView. When this happens PluginViewBase and PluginView can become one class.
150     virtual bool isPluginViewBase() const { return false; }
151     virtual bool isScrollbar() const { return false; }
152     virtual bool isScrollView() const { return false; }
153
154     void removeFromParent();
155     virtual void setParent(ScrollView* view);
156     ScrollView* parent() const { return m_parent; }
157     ScrollView* root() const;
158
159     virtual void handleEvent(Event*) { }
160
161     virtual void notifyWidget(WidgetNotification) { }
162
163     IntRect convertToRootView(const IntRect&) const;
164     IntRect convertFromRootView(const IntRect&) const;
165
166     IntPoint convertToRootView(const IntPoint&) const;
167     IntPoint convertFromRootView(const IntPoint&) const;
168
169     // It is important for cross-platform code to realize that Mac has flipped coordinates.  Therefore any code
170     // that tries to convert the location of a rect using the point-based convertFromContainingWindow will end
171     // up with an inaccurate rect.  Always make sure to use the rect-based convertFromContainingWindow method
172     // when converting window rects.
173     IntRect convertToContainingWindow(const IntRect&) const;
174     IntRect convertFromContainingWindow(const IntRect&) const;
175
176     IntPoint convertToContainingWindow(const IntPoint&) const;
177     IntPoint convertFromContainingWindow(const IntPoint&) const;
178
179     virtual void frameRectsChanged() { }
180
181     // Notifies this widget that its clip rect changed.
182     virtual void clipRectChanged() { }
183
184     // Whether transforms affect the frame rect. FIXME: We get rid of this and have
185     // the frame rects be the same no matter what transforms are applied.
186     virtual bool transformsAffectFrameRect() { return true; }
187
188 #if PLATFORM(MAC)
189     NSView* getOuterView() const;
190
191     void removeFromSuperview();
192 #endif
193
194 #if PLATFORM(EFL)
195     void setEvasObject(Evas_Object*);
196     Evas_Object* evasObject() { return m_evasObject; }
197 #endif
198
199     // Virtual methods to convert points to/from the containing ScrollView
200     virtual IntRect convertToContainingView(const IntRect&) const;
201     virtual IntRect convertFromContainingView(const IntRect&) const;
202     virtual IntPoint convertToContainingView(const IntPoint&) const;
203     virtual IntPoint convertFromContainingView(const IntPoint&) const;
204
205 private:
206     void init(PlatformWidget); // Must be called by all Widget constructors to initialize cross-platform data.
207
208     void releasePlatformWidget();
209     void retainPlatformWidget();
210
211     // These methods are used to convert from the root widget to the containing window,
212     // which has behavior that may differ between platforms (e.g. Mac uses flipped window coordinates).
213     static IntRect convertFromRootToContainingWindow(const Widget* rootWidget, const IntRect&);
214     static IntRect convertFromContainingWindowToRoot(const Widget* rootWidget, const IntRect&);
215
216     static IntPoint convertFromRootToContainingWindow(const Widget* rootWidget, const IntPoint&);
217     static IntPoint convertFromContainingWindowToRoot(const Widget* rootWidget, const IntPoint&);
218
219 private:
220     ScrollView* m_parent;
221 #if !PLATFORM(MAC)
222     PlatformWidget m_widget;
223 #else
224     RetainPtr<NSView> m_widget;
225 #endif
226     bool m_selfVisible;
227     bool m_parentVisible;
228
229     IntRect m_frame; // Not used when a native widget exists.
230
231 #if PLATFORM(EFL)
232     Evas_Object* m_evasObject;
233 #endif
234 };
235
236 #if !PLATFORM(MAC)
237
238 inline PlatformWidget Widget::platformWidget() const
239 {
240     return m_widget;
241 }
242
243 inline void Widget::setPlatformWidget(PlatformWidget widget)
244 {
245     if (widget != m_widget) {
246         releasePlatformWidget();
247         m_widget = widget;
248         retainPlatformWidget();
249     }
250 }
251
252 #endif
253
254 #if !PLATFORM(GTK)
255
256 inline void Widget::releasePlatformWidget()
257 {
258 }
259
260 inline void Widget::retainPlatformWidget()
261 {
262 }
263
264 #endif
265
266 } // namespace WebCore
267
268 #endif // Widget_h