Add RegisterProtocolHandlerClient to the Modules/protocolhandler
[WebKit-https.git] / Source / WebCore / page / ChromeClient.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 Apple, Inc. All rights reserved.
3  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
4  * Copyright (C) 2012 Samsung Electronics. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #ifndef ChromeClient_h
23 #define ChromeClient_h
24
25 #include "AXObjectCache.h"
26 #include "ConsoleTypes.h"
27 #include "Cursor.h"
28 #include "FocusDirection.h"
29 #include "FrameLoader.h"
30 #include "GraphicsContext.h"
31 #include "HostWindow.h"
32 #include "PopupMenu.h"
33 #include "PopupMenuClient.h"
34 #include "RenderEmbeddedObject.h"
35 #include "ScrollTypes.h"
36 #include "SearchPopupMenu.h"
37 #include "WebCoreKeyboardUIMode.h"
38 #include <wtf/Forward.h>
39 #include <wtf/PassOwnPtr.h>
40 #include <wtf/UnusedParam.h>
41 #include <wtf/Vector.h>
42
43 #ifndef __OBJC__
44 class NSMenu;
45 class NSResponder;
46 #endif
47
48 namespace WebCore {
49
50     class AccessibilityObject;
51     class Element;
52     class FileChooser;
53     class FileIconLoader;
54     class FloatRect;
55     class Frame;
56     class Geolocation;
57     class GraphicsLayer;
58     class HTMLInputElement;
59     class HitTestResult;
60     class IntRect;
61     class NavigationAction;
62     class Node;
63     class Page;
64     class PagePopup;
65     class PagePopupClient;
66     class PagePopupDriver;
67     class PopupMenuClient;
68     class SecurityOrigin;
69     class GraphicsContext3D;
70     class Widget;
71
72     struct FrameLoadRequest;
73     struct ViewportArguments;
74     struct WindowFeatures;
75
76 #if USE(ACCELERATED_COMPOSITING)
77     class GraphicsLayer;
78 #endif
79
80 #if ENABLE(INPUT_TYPE_COLOR)
81     class ColorChooser;
82     class ColorChooserClient;
83 #endif
84
85 #if PLATFORM(WIN) && USE(AVFOUNDATION)
86     struct GraphicsDeviceAdapter;
87 #endif
88
89     class ChromeClient {
90     public:
91         virtual void chromeDestroyed() = 0;
92         
93         virtual void setWindowRect(const FloatRect&) = 0;
94         virtual FloatRect windowRect() = 0;
95         
96         virtual FloatRect pageRect() = 0;
97         
98         virtual void focus() = 0;
99         virtual void unfocus() = 0;
100
101         virtual bool canTakeFocus(FocusDirection) = 0;
102         virtual void takeFocus(FocusDirection) = 0;
103
104         virtual void focusedNodeChanged(Node*) = 0;
105         virtual void focusedFrameChanged(Frame*) = 0;
106
107         // The Frame pointer provides the ChromeClient with context about which
108         // Frame wants to create the new Page.  Also, the newly created window
109         // should not be shown to the user until the ChromeClient of the newly
110         // created Page has its show method called.
111         // The FrameLoadRequest parameter is only for ChromeClient to check if the
112         // request could be fulfilled.  The ChromeClient should not load the request.
113         virtual Page* createWindow(Frame*, const FrameLoadRequest&, const WindowFeatures&, const NavigationAction&) = 0;
114         virtual void show() = 0;
115
116         virtual bool canRunModal() = 0;
117         virtual void runModal() = 0;
118
119         virtual void setToolbarsVisible(bool) = 0;
120         virtual bool toolbarsVisible() = 0;
121         
122         virtual void setStatusbarVisible(bool) = 0;
123         virtual bool statusbarVisible() = 0;
124         
125         virtual void setScrollbarsVisible(bool) = 0;
126         virtual bool scrollbarsVisible() = 0;
127         
128         virtual void setMenubarVisible(bool) = 0;
129         virtual bool menubarVisible() = 0;
130
131         virtual void setResizable(bool) = 0;
132         
133         virtual void addMessageToConsole(MessageSource, MessageType, MessageLevel, const String& message, unsigned int lineNumber, const String& sourceID) = 0;
134
135         virtual bool canRunBeforeUnloadConfirmPanel() = 0;
136         virtual bool runBeforeUnloadConfirmPanel(const String& message, Frame* frame) = 0;
137
138         virtual void closeWindowSoon() = 0;
139         
140         virtual void runJavaScriptAlert(Frame*, const String&) = 0;
141         virtual bool runJavaScriptConfirm(Frame*, const String&) = 0;
142         virtual bool runJavaScriptPrompt(Frame*, const String& message, const String& defaultValue, String& result) = 0;
143         virtual void setStatusbarText(const String&) = 0;
144         virtual bool shouldInterruptJavaScript() = 0;
145         virtual KeyboardUIMode keyboardUIMode() = 0;
146
147         virtual void* webView() const = 0;
148
149         virtual IntRect windowResizerRect() const = 0;
150
151         // Methods used by HostWindow.
152         virtual void invalidateRootView(const IntRect&, bool) = 0;
153         virtual void invalidateContentsAndRootView(const IntRect&, bool) = 0;
154         virtual void invalidateContentsForSlowScroll(const IntRect&, bool) = 0;
155         virtual void scroll(const IntSize&, const IntRect&, const IntRect&) = 0;
156 #if USE(TILED_BACKING_STORE)
157         virtual void delegatedScrollRequested(const IntPoint&) = 0;
158 #endif
159         virtual IntPoint screenToRootView(const IntPoint&) const = 0;
160         virtual IntRect rootViewToScreen(const IntRect&) const = 0;
161         virtual PlatformPageClient platformPageClient() const = 0;
162         virtual void scrollbarsModeDidChange() const = 0;
163         virtual void setCursor(const Cursor&) = 0;
164         virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
165 #if ENABLE(REQUEST_ANIMATION_FRAME) && !USE(REQUEST_ANIMATION_FRAME_TIMER)
166         virtual void scheduleAnimation() = 0;
167 #endif
168         // End methods used by HostWindow.
169
170         virtual void dispatchViewportPropertiesDidChange(const ViewportArguments&) const { }
171
172         virtual void contentsSizeChanged(Frame*, const IntSize&) const = 0;
173         virtual void layoutUpdated(Frame*) const { }
174         virtual void scrollRectIntoView(const IntRect&) const { }; // Currently only Mac has a non empty implementation.
175        
176         virtual bool shouldUnavailablePluginMessageBeButton(RenderEmbeddedObject::PluginUnavailabilityReason) const { return false; }
177         virtual void unavailablePluginButtonClicked(Element*, RenderEmbeddedObject::PluginUnavailabilityReason) const { }
178         virtual void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags) = 0;
179
180         virtual void setToolTip(const String&, TextDirection) = 0;
181
182         virtual void print(Frame*) = 0;
183         virtual bool shouldRubberBandInDirection(ScrollDirection) const = 0;
184
185 #if ENABLE(SQL_DATABASE)
186         virtual void exceededDatabaseQuota(Frame*, const String& databaseName) = 0;
187 #endif
188
189         // Callback invoked when the application cache fails to save a cache object
190         // because storing it would grow the database file past its defined maximum
191         // size or past the amount of free space on the device. 
192         // The chrome client would need to take some action such as evicting some
193         // old caches.
194         virtual void reachedMaxAppCacheSize(int64_t spaceNeeded) = 0;
195
196         // Callback invoked when the application cache origin quota is reached. This
197         // means that the resources attempting to be cached via the manifest are
198         // more than allowed on this origin. This callback allows the chrome client
199         // to take action, such as prompting the user to ask to increase the quota
200         // for this origin. The totalSpaceNeeded parameter is the total amount of
201         // storage, in bytes, needed to store the new cache along with all of the
202         // other existing caches for the origin that would not be replaced by
203         // the new cache.
204         virtual void reachedApplicationCacheOriginQuota(SecurityOrigin*, int64_t totalSpaceNeeded) = 0;
205
206 #if ENABLE(DASHBOARD_SUPPORT)
207         virtual void dashboardRegionsChanged();
208 #endif
209
210         virtual void populateVisitedLinks();
211
212         virtual FloatRect customHighlightRect(Node*, const AtomicString& type, const FloatRect& lineRect);
213         virtual void paintCustomHighlight(Node*, const AtomicString& type, const FloatRect& boxRect, const FloatRect& lineRect,
214             bool behindText, bool entireLine);
215             
216         virtual bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename);
217         virtual String generateReplacementFile(const String& path);
218
219         virtual bool paintCustomOverhangArea(GraphicsContext*, const IntRect&, const IntRect&, const IntRect&);
220
221 #if ENABLE(INPUT_TYPE_COLOR)
222         virtual PassOwnPtr<ColorChooser> createColorChooser(ColorChooserClient*, const Color&) = 0;
223 #endif
224
225         virtual void runOpenPanel(Frame*, PassRefPtr<FileChooser>) = 0;
226         // Asynchronous request to load an icon for specified filenames.
227         virtual void loadIconForFiles(const Vector<String>&, FileIconLoader*) = 0;
228
229 #if ENABLE(DIRECTORY_UPLOAD)
230         // Asychronous request to enumerate all files in a directory chosen by the user.
231         virtual void enumerateChosenDirectory(FileChooser*) = 0;
232 #endif
233
234         // Notification that the given form element has changed. This function
235         // will be called frequently, so handling should be very fast.
236         virtual void formStateDidChange(const Node*) = 0;
237         
238         virtual void elementDidFocus(const Node*) { };
239         virtual void elementDidBlur(const Node*) { };
240
241 #if USE(ACCELERATED_COMPOSITING)
242         // Pass 0 as the GraphicsLayer to detatch the root layer.
243         virtual void attachRootGraphicsLayer(Frame*, GraphicsLayer*) = 0;
244         // Sets a flag to specify that the next time content is drawn to the window,
245         // the changes appear on the screen in synchrony with updates to GraphicsLayers.
246         virtual void setNeedsOneShotDrawingSynchronization() = 0;
247         // Sets a flag to specify that the view needs to be updated, so we need
248         // to do an eager layout before the drawing.
249         virtual void scheduleCompositingLayerSync() = 0;
250         // Returns whether or not the client can render the composited layer,
251         // regardless of the settings.
252         virtual bool allowsAcceleratedCompositing() const { return true; }
253
254         enum CompositingTrigger {
255             ThreeDTransformTrigger = 1 << 0,
256             VideoTrigger = 1 << 1,
257             PluginTrigger = 1 << 2,
258             CanvasTrigger = 1 << 3,
259             AnimationTrigger = 1 << 4,
260             FilterTrigger = 1 << 5,
261             AllTriggers = 0xFFFFFFFF
262         };
263         typedef unsigned CompositingTriggerFlags;
264
265         // Returns a bitfield indicating conditions that can trigger the compositor.
266         virtual CompositingTriggerFlags allowedCompositingTriggers() const { return static_cast<CompositingTriggerFlags>(AllTriggers); }
267 #endif
268
269 #if PLATFORM(WIN) && USE(AVFOUNDATION)
270         virtual GraphicsDeviceAdapter* graphicsDeviceAdapter() const { return 0; }
271 #endif
272
273         virtual bool supportsFullscreenForNode(const Node*) { return false; }
274         virtual void enterFullscreenForNode(Node*) { }
275         virtual void exitFullscreenForNode(Node*) { }
276         virtual bool requiresFullscreenForVideoPlayback() { return false; } 
277
278 #if ENABLE(FULLSCREEN_API)
279         virtual bool supportsFullScreenForElement(const Element*, bool) { return false; }
280         virtual void enterFullScreenForElement(Element*) { }
281         virtual void exitFullScreenForElement(Element*) { }
282         virtual void fullScreenRendererChanged(RenderBox*) { }
283         virtual void setRootFullScreenLayer(GraphicsLayer*) { }
284 #endif
285         
286 #if USE(TILED_BACKING_STORE)
287         virtual IntRect visibleRectForTiledBackingStore() const { return IntRect(); }
288 #endif
289
290 #if PLATFORM(MAC)
291         virtual NSResponder *firstResponder() { return 0; }
292         virtual void makeFirstResponder(NSResponder *) { }
293         // Focuses on the containing view associated with this page.
294         virtual void makeFirstResponder() { }
295         virtual void willPopUpMenu(NSMenu *) { }
296 #endif
297
298 #if PLATFORM(WIN)
299         virtual void setLastSetCursorToCurrentCursor() = 0;
300 #endif
301
302 #if ENABLE(TOUCH_EVENTS)
303         virtual void needTouchEvents(bool) = 0;
304 #endif
305
306         virtual bool selectItemWritingDirectionIsNatural() = 0;
307         virtual bool selectItemAlignmentFollowsMenuWritingDirection() = 0;
308         // Checks if there is an opened popup, called by RenderMenuList::showPopup().
309         virtual bool hasOpenedPopup() const = 0;
310         virtual PassRefPtr<PopupMenu> createPopupMenu(PopupMenuClient*) const = 0;
311         virtual PassRefPtr<SearchPopupMenu> createSearchPopupMenu(PopupMenuClient*) const = 0;
312 #if ENABLE(PAGE_POPUP)
313         // Creates a PagePopup object, and shows it beside originBoundsInRootView.
314         // The return value can be 0.
315         virtual PagePopup* openPagePopup(PagePopupClient*, const IntRect& originBoundsInRootView) = 0;
316         virtual void closePagePopup(PagePopup*) = 0;
317         // For testing.
318         virtual void setPagePopupDriver(PagePopupDriver*) = 0;
319         virtual void resetPagePopupDriver() = 0;
320 #endif
321         // This function is called whenever a text field <input> is
322         // created. The implementation should return true if it wants
323         // to do something in addTextFieldDecorationsTo().
324         // The argument is always non-0.
325         virtual bool willAddTextFieldDecorationsTo(HTMLInputElement*) { return false; }
326         // The argument is always non-0.
327         virtual void addTextFieldDecorationsTo(HTMLInputElement*) { }
328
329         virtual void postAccessibilityNotification(AccessibilityObject*, AXObjectCache::AXNotification) { }
330         
331         virtual void notifyScrollerThumbIsVisibleInRect(const IntRect&) { }
332         virtual void recommendedScrollbarStyleDidChange(int /*newStyle*/) { }
333
334         enum DialogType {
335             AlertDialog = 0,
336             ConfirmDialog = 1,
337             PromptDialog = 2,
338             HTMLDialog = 3
339         };
340         virtual bool shouldRunModalDialogDuringPageDismissal(const DialogType&, const String& dialogMessage, FrameLoader::PageDismissalType) const { UNUSED_PARAM(dialogMessage); return true; }
341
342         virtual void numWheelEventHandlersChanged(unsigned) = 0;
343         virtual void numTouchEventHandlersChanged(unsigned) = 0;
344         
345         virtual bool isSVGImageChromeClient() const { return false; }
346
347 #if ENABLE(POINTER_LOCK)
348         virtual bool requestPointerLock() { return false; }
349         virtual void requestPointerUnlock() { }
350         virtual bool isPointerLocked() { return false; }
351 #endif
352
353     protected:
354         virtual ~ChromeClient() { }
355     };
356
357 }
358 #endif // ChromeClient_h