Reviewed by Darin Adler.
[WebKit-https.git] / Source / WebCore / page / ChromeClient.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009 Apple, Inc. All rights reserved.
3  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #ifndef ChromeClient_h
22 #define ChromeClient_h
23
24 #include "AXObjectCache.h"
25 #include "Console.h"
26 #include "Cursor.h"
27 #include "FocusDirection.h"
28 #include "GraphicsContext.h"
29 #include "HostWindow.h"
30 #include "PopupMenu.h"
31 #include "PopupMenuClient.h"
32 #include "ScrollTypes.h"
33 #include "SearchPopupMenu.h"
34 #include <wtf/Forward.h>
35 #include <wtf/PassOwnPtr.h>
36 #include <wtf/Vector.h>
37
38 #if PLATFORM(MAC)
39 #include "WebCoreKeyboardUIMode.h"
40 #endif
41
42 #ifndef __OBJC__
43 class NSMenu;
44 class NSResponder;
45 #endif
46
47 namespace WebCore {
48
49     class AccessibilityObject;
50     class Element;
51     class FileChooser;
52     class FloatRect;
53     class Frame;
54     class Geolocation;
55     class HitTestResult;
56     class IntRect;
57     class NavigationAction;
58     class Node;
59     class Page;
60     class PopupMenuClient;
61     class SecurityOrigin;
62     class SharedGraphicsContext3D;
63     class Widget;
64
65     struct FrameLoadRequest;
66     struct ViewportArguments;
67     struct WindowFeatures;
68
69 #if USE(ACCELERATED_COMPOSITING)
70     class GraphicsLayer;
71 #endif
72
73 #if ENABLE(NOTIFICATIONS)
74     class NotificationPresenter;
75 #endif
76
77     class ChromeClient {
78     public:
79         virtual void chromeDestroyed() = 0;
80         
81         virtual void setWindowRect(const FloatRect&) = 0;
82         virtual FloatRect windowRect() = 0;
83         
84         virtual FloatRect pageRect() = 0;
85         
86         virtual float scaleFactor() = 0;
87     
88         virtual void focus() = 0;
89         virtual void unfocus() = 0;
90
91         virtual bool canTakeFocus(FocusDirection) = 0;
92         virtual void takeFocus(FocusDirection) = 0;
93
94         virtual void focusedNodeChanged(Node*) = 0;
95         virtual void focusedFrameChanged(Frame*) = 0;
96
97         // The Frame pointer provides the ChromeClient with context about which
98         // Frame wants to create the new Page.  Also, the newly created window
99         // should not be shown to the user until the ChromeClient of the newly
100         // created Page has its show method called.
101         // The FrameLoadRequest parameter is only for ChromeClient to check if the
102         // request could be fulfilled.  The ChromeClient should not load the request.
103         virtual Page* createWindow(Frame*, const FrameLoadRequest&, const WindowFeatures&, const NavigationAction&) = 0;
104         virtual void show() = 0;
105
106         virtual bool canRunModal() = 0;
107         virtual void runModal() = 0;
108
109         virtual void setToolbarsVisible(bool) = 0;
110         virtual bool toolbarsVisible() = 0;
111         
112         virtual void setStatusbarVisible(bool) = 0;
113         virtual bool statusbarVisible() = 0;
114         
115         virtual void setScrollbarsVisible(bool) = 0;
116         virtual bool scrollbarsVisible() = 0;
117         
118         virtual void setMenubarVisible(bool) = 0;
119         virtual bool menubarVisible() = 0;
120
121         virtual void setResizable(bool) = 0;
122         
123         virtual void addMessageToConsole(MessageSource, MessageType, MessageLevel, const String& message, unsigned int lineNumber, const String& sourceID) = 0;
124
125         virtual bool canRunBeforeUnloadConfirmPanel() = 0;
126         virtual bool runBeforeUnloadConfirmPanel(const String& message, Frame* frame) = 0;
127
128         virtual void closeWindowSoon() = 0;
129         
130         virtual void runJavaScriptAlert(Frame*, const String&) = 0;
131         virtual bool runJavaScriptConfirm(Frame*, const String&) = 0;
132         virtual bool runJavaScriptPrompt(Frame*, const String& message, const String& defaultValue, String& result) = 0;
133         virtual void setStatusbarText(const String&) = 0;
134         virtual bool shouldInterruptJavaScript() = 0;
135         virtual KeyboardUIMode keyboardUIMode() = 0;
136
137 #if ENABLE(REGISTER_PROTOCOL_HANDLER)
138         virtual void registerProtocolHandler(const String& scheme, const String& baseURL, const String& url, const String& title) = 0;
139 #endif
140
141         virtual IntRect windowResizerRect() const = 0;
142
143         // Methods used by HostWindow.
144         virtual void invalidateWindow(const IntRect&, bool) = 0;
145         virtual void invalidateContentsAndWindow(const IntRect&, bool) = 0;
146         virtual void invalidateContentsForSlowScroll(const IntRect&, bool) = 0;
147         virtual void scroll(const IntSize&, const IntRect&, const IntRect&) = 0;
148 #if ENABLE(TILED_BACKING_STORE)
149         virtual void delegatedScrollRequested(const IntSize&) = 0;
150 #endif
151         virtual IntPoint screenToWindow(const IntPoint&) const = 0;
152         virtual IntRect windowToScreen(const IntRect&) const = 0;
153         virtual PlatformPageClient platformPageClient() const = 0;
154         virtual void scrollbarsModeDidChange() const = 0;
155         virtual void setCursor(const Cursor&) = 0;
156 #if ENABLE(REQUEST_ANIMATION_FRAME)
157         virtual void scheduleAnimation() = 0;
158 #endif
159         // End methods used by HostWindow.
160
161         virtual void dispatchViewportDataDidChange(const ViewportArguments&) const { }
162
163         virtual void contentsSizeChanged(Frame*, const IntSize&) const = 0;
164         virtual void scrollRectIntoView(const IntRect&, const ScrollView*) const = 0; // Currently only Mac has a non empty implementation.
165        
166         virtual bool shouldMissingPluginMessageBeButton() const { return false; }
167         virtual void missingPluginButtonClicked(Element*) const { }
168         virtual void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags) = 0;
169
170         virtual void setToolTip(const String&, TextDirection) = 0;
171
172         virtual void print(Frame*) = 0;
173
174 #if ENABLE(DATABASE)
175         virtual void exceededDatabaseQuota(Frame*, const String& databaseName) = 0;
176 #endif
177
178 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
179         // Callback invoked when the application cache fails to save a cache object
180         // because storing it would grow the database file past its defined maximum
181         // size or past the amount of free space on the device. 
182         // The chrome client would need to take some action such as evicting some
183         // old caches.
184         virtual void reachedMaxAppCacheSize(int64_t spaceNeeded) = 0;
185
186         // Callback invoked when the application cache origin quota is reached. This
187         // means that the resources attempting to be cached via the manifest are
188         // more than allowed on this origin. This callback allows the chrome client
189         // to take action, such as prompting the user to ask to increase the quota
190         // for this origin.
191         virtual void reachedApplicationCacheOriginQuota(SecurityOrigin* origin) = 0;
192 #endif
193
194 #if ENABLE(DASHBOARD_SUPPORT)
195         virtual void dashboardRegionsChanged();
196 #endif
197
198 #if ENABLE(NOTIFICATIONS)
199         virtual NotificationPresenter* notificationPresenter() const = 0;
200 #endif
201
202         virtual void populateVisitedLinks();
203
204         virtual FloatRect customHighlightRect(Node*, const AtomicString& type, const FloatRect& lineRect);
205         virtual void paintCustomHighlight(Node*, const AtomicString& type, const FloatRect& boxRect, const FloatRect& lineRect,
206             bool behindText, bool entireLine);
207             
208         virtual bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename);
209         virtual String generateReplacementFile(const String& path);
210
211         virtual bool paintCustomScrollbar(GraphicsContext*, const FloatRect&, ScrollbarControlSize, 
212                                           ScrollbarControlState, ScrollbarPart pressedPart, bool vertical,
213                                           float value, float proportion, ScrollbarControlPartMask);
214         virtual bool paintCustomScrollCorner(GraphicsContext*, const FloatRect&);
215
216         virtual bool paintCustomOverhangArea(GraphicsContext*, const IntRect&, const IntRect&, const IntRect&);
217
218         // FIXME: Remove once all ports are using client-based geolocation. https://bugs.webkit.org/show_bug.cgi?id=40373
219         // For client-based geolocation, these two methods have moved to GeolocationClient. https://bugs.webkit.org/show_bug.cgi?id=50061
220         // This can be either a synchronous or asynchronous call. The ChromeClient can display UI asking the user for permission
221         // to use Geolocation.
222         virtual void requestGeolocationPermissionForFrame(Frame*, Geolocation*) = 0;
223         virtual void cancelGeolocationPermissionRequestForFrame(Frame*, Geolocation*) = 0;
224
225         virtual void runOpenPanel(Frame*, PassRefPtr<FileChooser>) = 0;
226         // Asynchronous request to load an icon for specified filenames.
227         virtual void chooseIconForFiles(const Vector<String>&, FileChooser*) = 0;
228
229         // Notification that the given form element has changed. This function
230         // will be called frequently, so handling should be very fast.
231         virtual void formStateDidChange(const Node*) = 0;
232         
233         virtual void formDidFocus(const Node*) { };
234         virtual void formDidBlur(const Node*) { };
235
236 #if USE(ACCELERATED_COMPOSITING)
237         // Pass 0 as the GraphicsLayer to detatch the root layer.
238         virtual void attachRootGraphicsLayer(Frame*, GraphicsLayer*) = 0;
239         // Sets a flag to specify that the next time content is drawn to the window,
240         // the changes appear on the screen in synchrony with updates to GraphicsLayers.
241         virtual void setNeedsOneShotDrawingSynchronization() = 0;
242         // Sets a flag to specify that the view needs to be updated, so we need
243         // to do an eager layout before the drawing.
244         virtual void scheduleCompositingLayerSync() = 0;
245         // Returns whether or not the client can render the composited layer,
246         // regardless of the settings.
247         virtual bool allowsAcceleratedCompositing() const { return true; }
248
249         enum CompositingTrigger {
250             ThreeDTransformTrigger = 1 << 0,
251             VideoTrigger = 1 << 1,
252             PluginTrigger = 1 << 2,
253             CanvasTrigger = 1 << 3,
254             AnimationTrigger = 1 << 4,
255             AllTriggers = 0xFFFFFFFF
256         };
257         typedef unsigned CompositingTriggerFlags;
258
259         // Returns a bitfield indicating conditions that can trigger the compositor.
260         virtual CompositingTriggerFlags allowedCompositingTriggers() const { return static_cast<CompositingTriggerFlags>(AllTriggers); }
261 #endif
262
263         virtual bool supportsFullscreenForNode(const Node*) { return false; }
264         virtual void enterFullscreenForNode(Node*) { }
265         virtual void exitFullscreenForNode(Node*) { }
266         virtual bool requiresFullscreenForVideoPlayback() { return false; } 
267
268 #if ENABLE(FULLSCREEN_API)
269         virtual bool supportsFullScreenForElement(const Element*) { return false; }
270         virtual void enterFullScreenForElement(Element*) { }
271         virtual void exitFullScreenForElement(Element*) { }
272         virtual void fullScreenRendererChanged(RenderBox*) { }
273 #endif
274         
275 #if ENABLE(TILED_BACKING_STORE)
276         virtual IntRect visibleRectForTiledBackingStore() const { return IntRect(); }
277 #endif
278
279 #if PLATFORM(MAC)
280         virtual NSResponder *firstResponder() { return 0; }
281         virtual void makeFirstResponder(NSResponder *) { }
282
283         virtual void willPopUpMenu(NSMenu *) { }
284 #endif
285
286 #if PLATFORM(WIN)
287         virtual void setLastSetCursorToCurrentCursor() = 0;
288 #endif
289
290 #if ENABLE(TOUCH_EVENTS)
291         virtual void needTouchEvents(bool) = 0;
292 #endif
293
294         virtual bool selectItemWritingDirectionIsNatural() = 0;
295         virtual bool selectItemAlignmentFollowsMenuWritingDirection() = 0;
296         virtual PassRefPtr<PopupMenu> createPopupMenu(PopupMenuClient*) const = 0;
297         virtual PassRefPtr<SearchPopupMenu> createSearchPopupMenu(PopupMenuClient*) const = 0;
298
299 #if ENABLE(CONTEXT_MENUS)
300         virtual void showContextMenu() = 0;
301 #endif
302
303         virtual void postAccessibilityNotification(AccessibilityObject*, AXObjectCache::AXNotification) { }
304
305         virtual void didCompleteRubberBandForMainFrame(const IntSize&) const { }
306
307     protected:
308         virtual ~ChromeClient() { }
309     };
310
311 }
312
313 #endif // ChromeClient_h