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