2011-01-19 James Robinson <jamesr@chromium.org>
[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 "HTMLParserQuirks.h"
30 #include "HostWindow.h"
31 #include "PopupMenu.h"
32 #include "PopupMenuClient.h"
33 #include "ScrollTypes.h"
34 #include "SearchPopupMenu.h"
35 #include <wtf/Forward.h>
36 #include <wtf/PassOwnPtr.h>
37 #include <wtf/Vector.h>
38
39 #if PLATFORM(MAC)
40 #include "WebCoreKeyboardUIMode.h"
41 #endif
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 FloatRect;
54     class Frame;
55     class Geolocation;
56     class HTMLParserQuirks;
57     class HitTestResult;
58     class IntRect;
59     class NavigationAction;
60     class Node;
61     class Page;
62     class PopupMenuClient;
63     class SecurityOrigin;
64     class SharedGraphicsContext3D;
65     class Widget;
66
67     struct FrameLoadRequest;
68     struct ViewportArguments;
69     struct WindowFeatures;
70
71 #if USE(ACCELERATED_COMPOSITING)
72     class GraphicsLayer;
73 #endif
74
75 #if ENABLE(NOTIFICATIONS)
76     class NotificationPresenter;
77 #endif
78
79     class ChromeClient {
80     public:
81         virtual void chromeDestroyed() = 0;
82         
83         virtual void setWindowRect(const FloatRect&) = 0;
84         virtual FloatRect windowRect() = 0;
85         
86         virtual FloatRect pageRect() = 0;
87         
88         virtual float scaleFactor() = 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 bool tabsToLinks() const = 0;
138
139         virtual IntRect windowResizerRect() const = 0;
140
141         // Methods used by HostWindow.
142         virtual void invalidateWindow(const IntRect&, bool) = 0;
143         virtual void invalidateContentsAndWindow(const IntRect&, bool) = 0;
144         virtual void invalidateContentsForSlowScroll(const IntRect&, bool) = 0;
145         virtual void scroll(const IntSize&, const IntRect&, const IntRect&) = 0;
146 #if ENABLE(TILED_BACKING_STORE)
147         virtual void delegatedScrollRequested(const IntSize&) = 0;
148 #endif
149         virtual IntPoint screenToWindow(const IntPoint&) const = 0;
150         virtual IntRect windowToScreen(const IntRect&) const = 0;
151         virtual PlatformPageClient platformPageClient() const = 0;
152         virtual void scrollbarsModeDidChange() const = 0;
153         virtual void setCursor(const Cursor&) = 0;
154         // End methods used by HostWindow.
155
156         virtual void dispatchViewportDataDidChange(const ViewportArguments&) const { }
157
158         virtual void contentsSizeChanged(Frame*, const IntSize&) const = 0;
159         virtual void scrollRectIntoView(const IntRect&, const ScrollView*) const = 0; // Currently only Mac has a non empty implementation.
160        
161         virtual bool shouldMissingPluginMessageBeButton() const { return false; }
162         virtual void missingPluginButtonClicked(Element*) const { }
163         virtual void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags) = 0;
164
165         virtual void setToolTip(const String&, TextDirection) = 0;
166
167         virtual void print(Frame*) = 0;
168
169 #if ENABLE(DATABASE)
170         virtual void exceededDatabaseQuota(Frame*, const String& databaseName) = 0;
171 #endif
172
173 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
174         // Callback invoked when the application cache fails to save a cache object
175         // because storing it would grow the database file past its defined maximum
176         // size or past the amount of free space on the device. 
177         // The chrome client would need to take some action such as evicting some
178         // old caches.
179         virtual void reachedMaxAppCacheSize(int64_t spaceNeeded) = 0;
180
181         // Callback invoked when the application cache origin quota is reached. This
182         // means that the resources attempting to be cached via the manifest are
183         // more than allowed on this origin. This callback allows the chrome client
184         // to take action, such as prompting the user to ask to increase the quota
185         // for this origin.
186         virtual void reachedApplicationCacheOriginQuota(SecurityOrigin* origin) = 0;
187 #endif
188
189 #if ENABLE(DASHBOARD_SUPPORT)
190         virtual void dashboardRegionsChanged();
191 #endif
192
193 #if ENABLE(NOTIFICATIONS)
194         virtual NotificationPresenter* notificationPresenter() const = 0;
195 #endif
196
197         virtual void populateVisitedLinks();
198
199         virtual FloatRect customHighlightRect(Node*, const AtomicString& type, const FloatRect& lineRect);
200         virtual void paintCustomHighlight(Node*, const AtomicString& type, const FloatRect& boxRect, const FloatRect& lineRect,
201             bool behindText, bool entireLine);
202             
203         virtual bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename);
204         virtual String generateReplacementFile(const String& path);
205
206         virtual bool paintCustomScrollbar(GraphicsContext*, const FloatRect&, ScrollbarControlSize, 
207                                           ScrollbarControlState, ScrollbarPart pressedPart, bool vertical,
208                                           float value, float proportion, ScrollbarControlPartMask);
209         virtual bool paintCustomScrollCorner(GraphicsContext*, const FloatRect&);
210
211         // FIXME: Remove once all ports are using client-based geolocation. https://bugs.webkit.org/show_bug.cgi?id=40373
212         // For client-based geolocation, these two methods have moved to GeolocationClient. https://bugs.webkit.org/show_bug.cgi?id=50061
213         // This can be either a synchronous or asynchronous call. The ChromeClient can display UI asking the user for permission
214         // to use Geolocation.
215         virtual void requestGeolocationPermissionForFrame(Frame*, Geolocation*) = 0;
216         virtual void cancelGeolocationPermissionRequestForFrame(Frame*, Geolocation*) = 0;
217
218         virtual void runOpenPanel(Frame*, PassRefPtr<FileChooser>) = 0;
219         // Asynchronous request to load an icon for specified filenames.
220         virtual void chooseIconForFiles(const Vector<String>&, FileChooser*) = 0;
221
222         // Notification that the given form element has changed. This function
223         // will be called frequently, so handling should be very fast.
224         virtual void formStateDidChange(const Node*) = 0;
225         
226         virtual void formDidFocus(const Node*) { };
227         virtual void formDidBlur(const Node*) { };
228
229         virtual PassOwnPtr<HTMLParserQuirks> createHTMLParserQuirks() = 0;
230
231 #if USE(ACCELERATED_COMPOSITING)
232         // Pass 0 as the GraphicsLayer to detatch the root layer.
233         virtual void attachRootGraphicsLayer(Frame*, GraphicsLayer*) = 0;
234         // Sets a flag to specify that the next time content is drawn to the window,
235         // the changes appear on the screen in synchrony with updates to GraphicsLayers.
236         virtual void setNeedsOneShotDrawingSynchronization() = 0;
237         // Sets a flag to specify that the view needs to be updated, so we need
238         // to do an eager layout before the drawing.
239         virtual void scheduleCompositingLayerSync() = 0;
240         // Returns whether or not the client can render the composited layer,
241         // regardless of the settings.
242         virtual bool allowsAcceleratedCompositing() const { return true; }
243
244         enum CompositingTrigger {
245             ThreeDTransformTrigger = 1 << 0,
246             VideoTrigger = 1 << 1,
247             PluginTrigger = 1 << 2,
248             CanvasTrigger = 1 << 3,
249             AnimationTrigger = 1 << 4,
250             AllTriggers = 0xFFFFFFFF
251         };
252         typedef unsigned CompositingTriggerFlags;
253
254         // Returns a bitfield indicating conditions that can trigger the compositor.
255         virtual CompositingTriggerFlags allowedCompositingTriggers() const { return static_cast<CompositingTriggerFlags>(AllTriggers); }
256 #endif
257
258         virtual bool supportsFullscreenForNode(const Node*) { return false; }
259         virtual void enterFullscreenForNode(Node*) { }
260         virtual void exitFullscreenForNode(Node*) { }
261         virtual bool requiresFullscreenForVideoPlayback() { return false; } 
262
263 #if ENABLE(FULLSCREEN_API)
264         virtual bool supportsFullScreenForElement(const Element*) { return false; }
265         virtual void enterFullScreenForElement(Element*) { }
266         virtual void exitFullScreenForElement(Element*) { }
267         virtual void fullScreenRendererChanged(RenderBox*) { }
268 #endif
269         
270 #if ENABLE(TILED_BACKING_STORE)
271         virtual IntRect visibleRectForTiledBackingStore() const { return IntRect(); }
272 #endif
273
274 #if PLATFORM(MAC)
275         virtual KeyboardUIMode keyboardUIMode() { return KeyboardAccessDefault; }
276
277         virtual NSResponder *firstResponder() { return 0; }
278         virtual void makeFirstResponder(NSResponder *) { }
279
280         virtual void willPopUpMenu(NSMenu *) { }
281 #endif
282
283 #if PLATFORM(WIN)
284         virtual void setLastSetCursorToCurrentCursor() = 0;
285 #endif
286
287 #if ENABLE(TOUCH_EVENTS)
288         virtual void needTouchEvents(bool) = 0;
289 #endif
290
291         virtual bool selectItemWritingDirectionIsNatural() = 0;
292         virtual PassRefPtr<PopupMenu> createPopupMenu(PopupMenuClient*) const = 0;
293         virtual PassRefPtr<SearchPopupMenu> createSearchPopupMenu(PopupMenuClient*) const = 0;
294
295 #if ENABLE(CONTEXT_MENUS)
296         virtual void showContextMenu() = 0;
297 #endif
298
299         virtual void postAccessibilityNotification(AccessibilityObject*, AXObjectCache::AXNotification) { }
300
301     protected:
302         virtual ~ChromeClient() { }
303     };
304
305 }
306
307 #endif // ChromeClient_h