Get rid of didStartAnimatedScroll and didCompleteAnimatedScroll
[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 PopupMenuClient;
62     class SecurityOrigin;
63     class GraphicsContext3D;
64     class Widget;
65
66     struct FrameLoadRequest;
67     struct ViewportArguments;
68     struct WindowFeatures;
69
70 #if USE(ACCELERATED_COMPOSITING)
71     class GraphicsLayer;
72 #endif
73
74 #if ENABLE(INPUT_COLOR)
75     class ColorChooser;
76     class ColorChooserClient;
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 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         virtual void* webView() const = 0;
138
139 #if ENABLE(REGISTER_PROTOCOL_HANDLER)
140         virtual void registerProtocolHandler(const String& scheme, const String& baseURL, const String& url, const String& title) = 0;
141 #endif
142
143         virtual IntRect windowResizerRect() const = 0;
144
145         // Methods used by HostWindow.
146         virtual void invalidateRootView(const IntRect&, bool) = 0;
147         virtual void invalidateContentsAndRootView(const IntRect&, bool) = 0;
148         virtual void invalidateContentsForSlowScroll(const IntRect&, bool) = 0;
149         virtual void scroll(const IntSize&, const IntRect&, const IntRect&) = 0;
150 #if USE(TILED_BACKING_STORE)
151         virtual void delegatedScrollRequested(const IntPoint&) = 0;
152 #endif
153         virtual IntPoint screenToRootView(const IntPoint&) const = 0;
154         virtual IntRect rootViewToScreen(const IntRect&) const = 0;
155         virtual PlatformPageClient platformPageClient() const = 0;
156         virtual void scrollbarsModeDidChange() const = 0;
157         virtual void setCursor(const Cursor&) = 0;
158         virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
159 #if ENABLE(REQUEST_ANIMATION_FRAME) && !USE(REQUEST_ANIMATION_FRAME_TIMER)
160         virtual void scheduleAnimation() = 0;
161 #endif
162         // End methods used by HostWindow.
163
164         virtual void dispatchViewportPropertiesDidChange(const ViewportArguments&) const { }
165
166         virtual void contentsSizeChanged(Frame*, const IntSize&) const = 0;
167         virtual void layoutUpdated(Frame*) const { }
168         virtual void scrollRectIntoView(const IntRect&) const { }; // Currently only Mac has a non empty implementation.
169        
170         virtual bool shouldMissingPluginMessageBeButton() const { return false; }
171         virtual void missingPluginButtonClicked(Element*) const { }
172         virtual void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags) = 0;
173
174         virtual void setToolTip(const String&, TextDirection) = 0;
175
176         virtual void print(Frame*) = 0;
177         virtual bool shouldRubberBandInDirection(ScrollDirection) const = 0;
178
179 #if ENABLE(SQL_DATABASE)
180         virtual void exceededDatabaseQuota(Frame*, const String& databaseName) = 0;
181 #endif
182
183         // Callback invoked when the application cache fails to save a cache object
184         // because storing it would grow the database file past its defined maximum
185         // size or past the amount of free space on the device. 
186         // The chrome client would need to take some action such as evicting some
187         // old caches.
188         virtual void reachedMaxAppCacheSize(int64_t spaceNeeded) = 0;
189
190         // Callback invoked when the application cache origin quota is reached. This
191         // means that the resources attempting to be cached via the manifest are
192         // more than allowed on this origin. This callback allows the chrome client
193         // to take action, such as prompting the user to ask to increase the quota
194         // for this origin. The totalSpaceNeeded parameter is the total amount of
195         // storage, in bytes, needed to store the new cache along with all of the
196         // other existing caches for the origin that would not be replaced by
197         // the new cache.
198         virtual void reachedApplicationCacheOriginQuota(SecurityOrigin*, int64_t totalSpaceNeeded) = 0;
199
200 #if ENABLE(DASHBOARD_SUPPORT)
201         virtual void dashboardRegionsChanged();
202 #endif
203
204         virtual void populateVisitedLinks();
205
206         virtual FloatRect customHighlightRect(Node*, const AtomicString& type, const FloatRect& lineRect);
207         virtual void paintCustomHighlight(Node*, const AtomicString& type, const FloatRect& boxRect, const FloatRect& lineRect,
208             bool behindText, bool entireLine);
209             
210         virtual bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename);
211         virtual String generateReplacementFile(const String& path);
212
213         virtual bool paintCustomOverhangArea(GraphicsContext*, const IntRect&, const IntRect&, const IntRect&);
214
215         // FIXME: Remove once all ports are using client-based geolocation. https://bugs.webkit.org/show_bug.cgi?id=40373
216         // For client-based geolocation, these two methods have moved to GeolocationClient. https://bugs.webkit.org/show_bug.cgi?id=50061
217         // This can be either a synchronous or asynchronous call. The ChromeClient can display UI asking the user for permission
218         // to use Geolocation.
219         virtual void requestGeolocationPermissionForFrame(Frame*, Geolocation*) = 0;
220         virtual void cancelGeolocationPermissionRequestForFrame(Frame*, Geolocation*) = 0;
221
222 #if ENABLE(INPUT_COLOR)
223         virtual PassOwnPtr<ColorChooser> createColorChooser(ColorChooserClient*, const Color&) = 0;
224 #endif
225
226         virtual void runOpenPanel(Frame*, PassRefPtr<FileChooser>) = 0;
227         // Asynchronous request to load an icon for specified filenames.
228         virtual void loadIconForFiles(const Vector<String>&, FileIconLoader*) = 0;
229
230 #if ENABLE(DIRECTORY_UPLOAD)
231         // Asychronous request to enumerate all files in a directory chosen by the user.
232         virtual void enumerateChosenDirectory(FileChooser*) = 0;
233 #endif
234
235         // Notification that the given form element has changed. This function
236         // will be called frequently, so handling should be very fast.
237         virtual void formStateDidChange(const Node*) = 0;
238         
239         virtual void elementDidFocus(const Node*) { };
240         virtual void elementDidBlur(const Node*) { };
241
242 #if USE(ACCELERATED_COMPOSITING)
243         // Pass 0 as the GraphicsLayer to detatch the root layer.
244         virtual void attachRootGraphicsLayer(Frame*, GraphicsLayer*) = 0;
245         // Sets a flag to specify that the next time content is drawn to the window,
246         // the changes appear on the screen in synchrony with updates to GraphicsLayers.
247         virtual void setNeedsOneShotDrawingSynchronization() = 0;
248         // Sets a flag to specify that the view needs to be updated, so we need
249         // to do an eager layout before the drawing.
250         virtual void scheduleCompositingLayerSync() = 0;
251         // Returns whether or not the client can render the composited layer,
252         // regardless of the settings.
253         virtual bool allowsAcceleratedCompositing() const { return true; }
254
255         enum CompositingTrigger {
256             ThreeDTransformTrigger = 1 << 0,
257             VideoTrigger = 1 << 1,
258             PluginTrigger = 1 << 2,
259             CanvasTrigger = 1 << 3,
260             AnimationTrigger = 1 << 4,
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         virtual bool supportsFullscreenForNode(const Node*) { return false; }
270         virtual void enterFullscreenForNode(Node*) { }
271         virtual void exitFullscreenForNode(Node*) { }
272         virtual bool requiresFullscreenForVideoPlayback() { return false; } 
273
274 #if ENABLE(FULLSCREEN_API)
275         virtual bool supportsFullScreenForElement(const Element*, bool) { return false; }
276         virtual void enterFullScreenForElement(Element*) { }
277         virtual void exitFullScreenForElement(Element*) { }
278         virtual void fullScreenRendererChanged(RenderBox*) { }
279         virtual void setRootFullScreenLayer(GraphicsLayer*) { }
280 #endif
281         
282 #if USE(TILED_BACKING_STORE)
283         virtual IntRect visibleRectForTiledBackingStore() const { return IntRect(); }
284 #endif
285
286 #if PLATFORM(MAC)
287         virtual NSResponder *firstResponder() { return 0; }
288         virtual void makeFirstResponder(NSResponder *) { }
289         // Focuses on the containing view associated with this page.
290         virtual void makeFirstResponder() { }
291         virtual void willPopUpMenu(NSMenu *) { }
292 #endif
293
294 #if PLATFORM(WIN)
295         virtual void setLastSetCursorToCurrentCursor() = 0;
296 #endif
297
298 #if ENABLE(TOUCH_EVENTS)
299         virtual void needTouchEvents(bool) = 0;
300 #endif
301
302         virtual bool selectItemWritingDirectionIsNatural() = 0;
303         virtual bool selectItemAlignmentFollowsMenuWritingDirection() = 0;
304         // Checks if there is an opened popup, called by RenderMenuList::showPopup().
305         virtual bool hasOpenedPopup() const = 0;
306         virtual PassRefPtr<PopupMenu> createPopupMenu(PopupMenuClient*) const = 0;
307         virtual PassRefPtr<SearchPopupMenu> createSearchPopupMenu(PopupMenuClient*) const = 0;
308
309 #if ENABLE(CONTEXT_MENUS)
310         virtual void showContextMenu() = 0;
311 #endif
312
313         virtual void postAccessibilityNotification(AccessibilityObject*, AXObjectCache::AXNotification) { }
314         
315         virtual void notifyScrollerThumbIsVisibleInRect(const IntRect&) { }
316         virtual void recommendedScrollbarStyleDidChange(int /*newStyle*/) { }
317
318         enum DialogType {
319             AlertDialog = 0,
320             ConfirmDialog = 1,
321             PromptDialog = 2,
322             HTMLDialog = 3
323         };
324         virtual bool shouldRunModalDialogDuringPageDismissal(const DialogType&, const String& dialogMessage, FrameLoader::PageDismissalType) const { UNUSED_PARAM(dialogMessage); return true; }
325
326         virtual void numWheelEventHandlersChanged(unsigned) = 0;
327         
328         virtual bool isSVGImageChromeClient() const { return false; }
329
330     protected:
331         virtual ~ChromeClient() { }
332     };
333
334 }
335
336 #endif // ChromeClient_h