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