Unreviewed, rolling out r103169.
[WebKit-https.git] / Source / WebKit / chromium / public / WebViewClient.h
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebViewClient_h
32 #define WebViewClient_h
33
34 #include "WebAccessibilityNotification.h"
35 #include "WebDragOperation.h"
36 #include "WebEditingAction.h"
37 #include "WebFileChooserCompletion.h"
38 #include "WebFileChooserParams.h"
39 #include "WebPageVisibilityState.h"
40 #include "WebPopupType.h"
41 #include "WebTextAffinity.h"
42 #include "WebTextDirection.h"
43 #include "WebWidgetClient.h"
44 #include "platform/WebString.h"
45
46 namespace WebKit {
47
48 class WebAccessibilityObject;
49 class WebDeviceOrientationClient;
50 class WebDragData;
51 class WebElement;
52 class WebExternalPopupMenu;
53 class WebExternalPopupMenuClient;
54 class WebFileChooserCompletion;
55 class WebFrame;
56 class WebGeolocationClient;
57 class WebGeolocationService;
58 class WebIconLoadingCompletion;
59 class WebImage;
60 class WebInputElement;
61 class WebKeyboardEvent;
62 class WebNode;
63 class WebNotificationPresenter;
64 class WebRange;
65 class WebSpeechInputController;
66 class WebSpeechInputListener;
67 class WebStorageNamespace;
68 class WebURL;
69 class WebURLRequest;
70 class WebUserMediaClient;
71 class WebView;
72 class WebWidget;
73 struct WebConsoleMessage;
74 struct WebContextMenuData;
75 struct WebPoint;
76 struct WebPopupMenuInfo;
77 struct WebSize;
78 struct WebWindowFeatures;
79
80 // Since a WebView is a WebWidget, a WebViewClient is a WebWidgetClient.
81 // Virtual inheritance allows an implementation of WebWidgetClient to be
82 // easily reused as part of an implementation of WebViewClient.
83 class WebViewClient : virtual public WebWidgetClient {
84 public:
85     // Factory methods -----------------------------------------------------
86
87     // Create a new related WebView.  This method must clone its session storage
88     // so any subsequent calls to createSessionStorageNamespace conform to the
89     // WebStorage specification.
90     // The request parameter is only for the client to check if the request
91     // could be fulfilled.  The client should not load the request.
92     virtual WebView* createView(WebFrame* creator,
93                                 const WebURLRequest& request,
94                                 const WebWindowFeatures& features,
95                                 const WebString& name) {
96         return 0;
97     }
98
99     // Create a new WebPopupMenu.  In the second form, the client is
100     // responsible for rendering the contents of the popup menu.
101     virtual WebWidget* createPopupMenu(WebPopupType) { return 0; }
102     virtual WebWidget* createPopupMenu(const WebPopupMenuInfo&) { return 0; }
103     virtual WebExternalPopupMenu* createExternalPopupMenu(
104         const WebPopupMenuInfo&, WebExternalPopupMenuClient*) { return 0; }
105
106     // Create a session storage namespace object associated with this WebView.
107     virtual WebStorageNamespace* createSessionStorageNamespace(unsigned quota) { return 0; }
108
109     // Misc ----------------------------------------------------------------
110
111     // A new message was added to the console.
112     virtual void didAddMessageToConsole(
113         const WebConsoleMessage&, const WebString& sourceName, unsigned sourceLine) { }
114
115     // Called when script in the page calls window.print().  If frame is
116     // non-null, then it selects a particular frame, including its
117     // children, to print.  Otherwise, the main frame and its children
118     // should be printed.
119     virtual void printPage(WebFrame*) { }
120
121     // Called to retrieve the provider of desktop notifications.
122     virtual WebNotificationPresenter* notificationPresenter() { return 0; }
123
124     // Called to request an icon for the specified filenames.
125     // The icon is shown in a file upload control.
126     virtual bool queryIconForFiles(const WebVector<WebString>& filenames, WebIconLoadingCompletion*) { return false; }
127
128     // This method enumerates all the files in the path. It returns immediately
129     // and asynchronously invokes the WebFileChooserCompletion with all the
130     // files in the directory. Returns false if the WebFileChooserCompletion
131     // will never be called.
132     virtual bool enumerateChosenDirectory(const WebString& path, WebFileChooserCompletion*) { return false; }
133
134
135     // Navigational --------------------------------------------------------
136
137     // These notifications bracket any loading that occurs in the WebView.
138     virtual void didStartLoading() { }
139     virtual void didStopLoading() { }
140
141     // Notification that some progress was made loading the current page.
142     // loadProgress is a value between 0 (nothing loaded) and 1.0 (frame fully
143     // loaded).
144     virtual void didChangeLoadProgress(WebFrame*, double loadProgress) { }
145
146     // Editing -------------------------------------------------------------
147
148     // These methods allow the client to intercept and overrule editing
149     // operations.
150     virtual bool shouldBeginEditing(const WebRange&) { return true; }
151     virtual bool shouldEndEditing(const WebRange&) { return true; }
152     virtual bool shouldInsertNode(
153         const WebNode&, const WebRange&, WebEditingAction) { return true; }
154     virtual bool shouldInsertText(
155         const WebString&, const WebRange&, WebEditingAction) { return true; }
156     virtual bool shouldChangeSelectedRange(
157         const WebRange& from, const WebRange& to, WebTextAffinity,
158         bool stillSelecting) { return true; }
159     virtual bool shouldDeleteRange(const WebRange&) { return true; }
160     virtual bool shouldApplyStyle(const WebString& style, const WebRange&) { return true; }
161
162     virtual bool isSmartInsertDeleteEnabled() { return true; }
163     virtual bool isSelectTrailingWhitespaceEnabled() { return true; }
164
165     virtual void didBeginEditing() { }
166     virtual void didChangeSelection(bool isSelectionEmpty) { }
167     virtual void didChangeContents() { }
168     virtual void didExecuteCommand(const WebString& commandName) { }
169     virtual void didEndEditing() { }
170
171     // This method is called in response to WebView's handleInputEvent()
172     // when the default action for the current keyboard event is not
173     // suppressed by the page, to give the embedder a chance to handle
174     // the keyboard event specially.
175     //
176     // Returns true if the keyboard event was handled by the embedder,
177     // indicating that the default action should be suppressed.
178     virtual bool handleCurrentKeyboardEvent() { return false; }
179
180
181     // Dialogs -------------------------------------------------------------
182
183     // This method returns immediately after showing the dialog. When the
184     // dialog is closed, it should call the WebFileChooserCompletion to
185     // pass the results of the dialog. Returns false if
186     // WebFileChooseCompletion will never be called.
187     virtual bool runFileChooser(const WebFileChooserParams&,
188                                 WebFileChooserCompletion*) { return false; }
189
190     // Displays a modal alert dialog containing the given message.  Returns
191     // once the user dismisses the dialog.
192     virtual void runModalAlertDialog(
193         WebFrame*, const WebString& message) { }
194
195     // Displays a modal confirmation dialog with the given message as
196     // description and OK/Cancel choices.  Returns true if the user selects
197     // 'OK' or false otherwise.
198     virtual bool runModalConfirmDialog(
199         WebFrame*, const WebString& message) { return false; }
200
201     // Displays a modal input dialog with the given message as description
202     // and OK/Cancel choices.  The input field is pre-filled with
203     // defaultValue.  Returns true if the user selects 'OK' or false
204     // otherwise.  Upon returning true, actualValue contains the value of
205     // the input field.
206     virtual bool runModalPromptDialog(
207         WebFrame*, const WebString& message, const WebString& defaultValue,
208         WebString* actualValue) { return false; }
209
210     // Displays a modal confirmation dialog containing the given message as
211     // description and OK/Cancel choices, where 'OK' means that it is okay
212     // to proceed with closing the view.  Returns true if the user selects
213     // 'OK' or false otherwise.
214     virtual bool runModalBeforeUnloadDialog(
215         WebFrame*, const WebString& message) { return true; }
216
217
218     // UI ------------------------------------------------------------------
219
220     // Called when script modifies window.status
221     virtual void setStatusText(const WebString&) { }
222
223     // Called when hovering over an anchor with the given URL.
224     virtual void setMouseOverURL(const WebURL&) { }
225
226     // Called when keyboard focus switches to an anchor with the given URL.
227     virtual void setKeyboardFocusURL(const WebURL&) { }
228
229     // Shows a context menu with commands relevant to a specific element on
230     // the given frame. Additional context data is supplied.
231     virtual void showContextMenu(WebFrame*, const WebContextMenuData&) { }
232
233     // Called when a drag-n-drop operation should begin.
234     virtual void startDragging(
235         const WebDragData&, WebDragOperationsMask, const WebImage&, const WebPoint&) { }
236
237     // Called to determine if drag-n-drop operations may initiate a page
238     // navigation.
239     virtual bool acceptsLoadDrops() { return true; }
240
241     // Take focus away from the WebView by focusing an adjacent UI element
242     // in the containing window.
243     virtual void focusNext() { }
244     virtual void focusPrevious() { }
245
246     // Called when a new node gets focused.
247     virtual void focusedNodeChanged(const WebNode&) { }
248
249     virtual void numberOfWheelEventHandlersChanged(unsigned) { }
250
251     // Indicates two things:
252     //   1) This view may have a new layout now.
253     //   2) Calling layout() is a no-op.
254     // After calling WebWidget::layout(), expect to get this notification
255     // unless the view did not need a layout.
256     virtual void didUpdateLayout() { }
257
258     // Session history -----------------------------------------------------
259
260     // Tells the embedder to navigate back or forward in session history by
261     // the given offset (relative to the current position in session
262     // history).
263     virtual void navigateBackForwardSoon(int offset) { }
264
265     // Returns the number of history items before/after the current
266     // history item.
267     virtual int historyBackListCount() { return 0; }
268     virtual int historyForwardListCount() { return 0; }
269
270     // Called to notify the embedder when a new history item is added.
271     virtual void didAddHistoryItem() { }
272
273
274     // Accessibility -------------------------------------------------------
275
276     // Notifies embedder about an accessibility notification.
277     virtual void postAccessibilityNotification(const WebAccessibilityObject&, WebAccessibilityNotification) { }
278
279
280     // Developer tools -----------------------------------------------------
281
282     // Called to notify the client that the inspector's settings were
283     // changed and should be saved.  See WebView::inspectorSettings.
284     virtual void didUpdateInspectorSettings() { }
285
286     virtual void didUpdateInspectorSetting(const WebString& key, const WebString& value) { }
287
288     // Geolocation ---------------------------------------------------------
289
290     // Access the embedder API for (client-based) geolocation client .
291     virtual WebGeolocationClient* geolocationClient() { return 0; }
292     // Access the embedder API for (non-client-based) geolocation services.
293     virtual WebGeolocationService* geolocationService() { return 0; }
294
295     // Speech --------------------------------------------------------------
296
297     // Access the embedder API for speech input services.
298     virtual WebSpeechInputController* speechInputController(
299         WebSpeechInputListener*) { return 0; }
300
301     // Device Orientation --------------------------------------------------
302
303     // Access the embedder API for device orientation services.
304     virtual WebDeviceOrientationClient* deviceOrientationClient() { return 0; }
305
306
307     // Zoom ----------------------------------------------------------------
308
309     // Informs the browser that the zoom levels for this frame have changed from
310     // the default values.
311     virtual void zoomLimitsChanged(double minimumLevel, double maximumLevel) { }
312
313     // Informs the browser that the zoom level has changed as a result of an
314     // action that wasn't initiated by the client.
315     virtual void zoomLevelChanged() { }
316
317     // Registers a new URL handler for the given protocol.
318     virtual void registerProtocolHandler(const WebString& scheme,
319                                          const WebString& baseUrl,
320                                          const WebString& url,
321                                          const WebString& title) { }
322
323     // Visibility -----------------------------------------------------------
324
325     // Returns the current visibility of the WebView.
326     virtual WebPageVisibilityState visibilityState() const
327     {
328         return WebPageVisibilityStateVisible;
329     }
330
331     // Media Streams -------------------------------------------------------
332
333     virtual WebUserMediaClient* userMediaClient() { return 0; }
334
335 protected:
336     ~WebViewClient() { }
337 };
338
339 } // namespace WebKit
340
341 #endif