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