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