[chromium] Clean up WebWidget / WebLayerTreeView interactions
[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 "../../../Platform/chromium/public/WebColor.h"
35 #include "../../../Platform/chromium/public/WebGraphicsContext3D.h"
36 #include "../../../Platform/chromium/public/WebString.h"
37 #include "WebAccessibilityNotification.h"
38 #include "WebContentDetectionResult.h"
39 #include "WebDragOperation.h"
40 #include "WebEditingAction.h"
41 #include "WebFileChooserCompletion.h"
42 #include "WebFileChooserParams.h"
43 #include "WebPageVisibilityState.h"
44 #include "WebPopupType.h"
45 #include "WebTextAffinity.h"
46 #include "WebTextDirection.h"
47 #include "WebWidgetClient.h"
48
49 namespace WebKit {
50
51 class WebAccessibilityObject;
52 class WebBatteryStatusClient;
53 class WebColorChooser;
54 class WebColorChooserClient;
55 class WebCompositorOutputSurface;
56 class WebDateTimeChooserCompletion;
57 class WebDeviceOrientationClient;
58 class WebDragData;
59 class WebElement;
60 class WebExternalPopupMenu;
61 class WebExternalPopupMenuClient;
62 class WebFileChooserCompletion;
63 class WebFrame;
64 class WebGeolocationClient;
65 class WebGeolocationService;
66 class WebGestureEvent;
67 class WebHelperPlugin;
68 class WebHitTestResult;
69 class WebIconLoadingCompletion;
70 class WebImage;
71 class WebInputElement;
72 class WebKeyboardEvent;
73 class WebNode;
74 class WebNotificationPresenter;
75 class WebRange;
76 class WebSpeechInputController;
77 class WebSpeechInputListener;
78 class WebSpeechRecognizer;
79 class WebStorageNamespace;
80 class WebURL;
81 class WebURLRequest;
82 class WebUserMediaClient;
83 class WebView;
84 class WebWidget;
85 struct WebConsoleMessage;
86 struct WebContextMenuData;
87 struct WebDateTimeChooserParams;
88 struct WebPoint;
89 struct WebPopupMenuInfo;
90 struct WebRect;
91 struct WebSize;
92 struct WebWindowFeatures;
93
94 // Since a WebView is a WebWidget, a WebViewClient is a WebWidgetClient.
95 // Virtual inheritance allows an implementation of WebWidgetClient to be
96 // easily reused as part of an implementation of WebViewClient.
97 class WebViewClient : virtual public WebWidgetClient {
98 public:
99     // Factory methods -----------------------------------------------------
100
101     // Create a new related WebView.  This method must clone its session storage
102     // so any subsequent calls to createSessionStorageNamespace conform to the
103     // WebStorage specification.
104     // The request parameter is only for the client to check if the request
105     // could be fulfilled.  The client should not load the request.
106     // The policy parameter indicates how the new view will be displayed in
107     // WebWidgetClient::show.
108     virtual WebView* createView(WebFrame* creator,
109                                 const WebURLRequest& request,
110                                 const WebWindowFeatures& features,
111                                 const WebString& name,
112                                 WebNavigationPolicy policy) {
113         return 0;
114     }
115
116     // Create a new WebPopupMenu.  In the second form, the client is
117     // responsible for rendering the contents of the popup menu.
118     virtual WebWidget* createPopupMenu(WebPopupType) { return 0; }
119     virtual WebWidget* createPopupMenu(const WebPopupMenuInfo&) { return 0; }
120     virtual WebExternalPopupMenu* createExternalPopupMenu(
121         const WebPopupMenuInfo&, WebExternalPopupMenuClient*) { return 0; }
122
123     // Create a session storage namespace object associated with this WebView.
124     virtual WebStorageNamespace* createSessionStorageNamespace(unsigned quota) { return 0; }
125
126
127     // Misc ----------------------------------------------------------------
128
129     // A new message was added to the console.
130     virtual void didAddMessageToConsole(
131         const WebConsoleMessage&, const WebString& sourceName, unsigned sourceLine) { }
132
133     // Called when script in the page calls window.print().  If frame is
134     // non-null, then it selects a particular frame, including its
135     // children, to print.  Otherwise, the main frame and its children
136     // should be printed.
137     virtual void printPage(WebFrame*) { }
138
139     // Called to retrieve the provider of desktop notifications.
140     virtual WebNotificationPresenter* notificationPresenter() { return 0; }
141
142     // Called to request an icon for the specified filenames.
143     // The icon is shown in a file upload control.
144     virtual bool queryIconForFiles(const WebVector<WebString>& filenames, WebIconLoadingCompletion*) { return false; }
145
146     // This method enumerates all the files in the path. It returns immediately
147     // and asynchronously invokes the WebFileChooserCompletion with all the
148     // files in the directory. Returns false if the WebFileChooserCompletion
149     // will never be called.
150     virtual bool enumerateChosenDirectory(const WebString& path, WebFileChooserCompletion*) { return false; }
151
152     // Creates the main WebFrame for the specified WebHelperPlugin.
153     // Called by WebHelperPlugin to provide the WebFrameClient interface for the WebFrame.
154     virtual void initializeHelperPluginWebFrame(WebHelperPlugin*) { }
155
156
157     // Navigational --------------------------------------------------------
158
159     // These notifications bracket any loading that occurs in the WebView.
160     virtual void didStartLoading() { }
161     virtual void didStopLoading() { }
162
163     // Notification that some progress was made loading the current page.
164     // loadProgress is a value between 0 (nothing loaded) and 1.0 (frame fully
165     // loaded).
166     virtual void didChangeLoadProgress(WebFrame*, double loadProgress) { }
167
168     // Editing -------------------------------------------------------------
169
170     // These methods allow the client to intercept and overrule editing
171     // operations.
172     virtual bool shouldBeginEditing(const WebRange&) { return true; }
173     virtual bool shouldEndEditing(const WebRange&) { return true; }
174     virtual bool shouldInsertNode(
175         const WebNode&, const WebRange&, WebEditingAction) { return true; }
176     virtual bool shouldInsertText(
177         const WebString&, const WebRange&, WebEditingAction) { return true; }
178     virtual bool shouldChangeSelectedRange(
179         const WebRange& from, const WebRange& to, WebTextAffinity,
180         bool stillSelecting) { return true; }
181     virtual bool shouldDeleteRange(const WebRange&) { return true; }
182     virtual bool shouldApplyStyle(const WebString& style, const WebRange&) { return true; }
183
184     virtual bool isSmartInsertDeleteEnabled() { return true; }
185     virtual bool isSelectTrailingWhitespaceEnabled() { return true; }
186
187     virtual void didBeginEditing() { }
188     virtual void didCancelCompositionOnSelectionChange() { }
189     virtual void didChangeSelection(bool isSelectionEmpty) { }
190     virtual void didChangeContents() { }
191     virtual void didExecuteCommand(const WebString& commandName) { }
192     virtual void didEndEditing() { }
193     virtual void didChangeFormState(const WebNode&) { }
194
195     // This method is called in response to WebView's handleInputEvent()
196     // when the default action for the current keyboard event is not
197     // suppressed by the page, to give the embedder a chance to handle
198     // the keyboard event specially.
199     //
200     // Returns true if the keyboard event was handled by the embedder,
201     // indicating that the default action should be suppressed.
202     virtual bool handleCurrentKeyboardEvent() { return false; }
203
204     // Dialogs -------------------------------------------------------------
205
206     // This method opens the color chooser and returns a new WebColorChooser
207     // instance. If there is a WebColorChooser already from the last time this
208     // was called, it ends the color chooser by calling endChooser, and replaces
209     // it with the new one.
210     virtual WebColorChooser* createColorChooser(WebColorChooserClient*,
211                                                 const WebColor&) { return 0; }
212
213     // This method returns immediately after showing the dialog. When the
214     // dialog is closed, it should call the WebFileChooserCompletion to
215     // pass the results of the dialog. Returns false if
216     // WebFileChooseCompletion will never be called.
217     virtual bool runFileChooser(const WebFileChooserParams&,
218                                 WebFileChooserCompletion*) { return false; }
219
220     // Ask users to choose date/time for the specified parameters. When a user
221     // chooses a value, an implementation of this function should call
222     // WebDateTimeChooserCompletion::didChooseValue or didCancelChooser. If the
223     // implementation opened date/time chooser UI successfully, it should return
224     // true. This function is used only if ExternalDateTimeChooser is used.
225     virtual bool openDateTimeChooser(const WebDateTimeChooserParams&, WebDateTimeChooserCompletion*) { return false; }
226
227     // Displays a modal alert dialog containing the given message.  Returns
228     // once the user dismisses the dialog.
229     virtual void runModalAlertDialog(
230         WebFrame*, const WebString& message) { }
231
232     // Displays a modal confirmation dialog with the given message as
233     // description and OK/Cancel choices.  Returns true if the user selects
234     // 'OK' or false otherwise.
235     virtual bool runModalConfirmDialog(
236         WebFrame*, const WebString& message) { return false; }
237
238     // Displays a modal input dialog with the given message as description
239     // and OK/Cancel choices.  The input field is pre-filled with
240     // defaultValue.  Returns true if the user selects 'OK' or false
241     // otherwise.  Upon returning true, actualValue contains the value of
242     // the input field.
243     virtual bool runModalPromptDialog(
244         WebFrame*, const WebString& message, const WebString& defaultValue,
245         WebString* actualValue) { return false; }
246
247     // Displays a modal confirmation dialog containing the given message as
248     // description and OK/Cancel choices, where 'OK' means that it is okay
249     // to proceed with closing the view.  Returns true if the user selects
250     // 'OK' or false otherwise.
251     virtual bool runModalBeforeUnloadDialog(
252         WebFrame*, const WebString& message) { return true; }
253
254
255     // UI ------------------------------------------------------------------
256
257     // Called when script modifies window.status
258     virtual void setStatusText(const WebString&) { }
259
260     // Called when hovering over an anchor with the given URL.
261     virtual void setMouseOverURL(const WebURL&) { }
262
263     // Called when keyboard focus switches to an anchor with the given URL.
264     virtual void setKeyboardFocusURL(const WebURL&) { }
265
266     // Shows a context menu with commands relevant to a specific element on
267     // the given frame. Additional context data is supplied.
268     virtual void showContextMenu(WebFrame*, const WebContextMenuData&) { }
269
270     // Called when a drag-n-drop operation should begin.
271     virtual void startDragging(WebFrame*, const WebDragData&, WebDragOperationsMask, const WebImage&, const WebPoint& dragImageOffset) { }
272
273     // Called to determine if drag-n-drop operations may initiate a page
274     // navigation.
275     virtual bool acceptsLoadDrops() { return true; }
276
277     // Take focus away from the WebView by focusing an adjacent UI element
278     // in the containing window.
279     virtual void focusNext() { }
280     virtual void focusPrevious() { }
281
282     // Called when a new node gets focused.
283     virtual void focusedNodeChanged(const WebNode&) { }
284
285     virtual void numberOfWheelEventHandlersChanged(unsigned) { }
286     virtual void hasTouchEventHandlers(bool) { }
287
288     // Indicates two things:
289     //   1) This view may have a new layout now.
290     //   2) Calling layout() is a no-op.
291     // After calling WebWidget::layout(), expect to get this notification
292     // unless the view did not need a layout.
293     virtual void didUpdateLayout() { }
294
295     // Return true to swallow the input event if the embedder will start a disambiguation popup
296     virtual bool didTapMultipleTargets(const WebGestureEvent&, const WebVector<WebRect>& targetRects) { return false; }
297
298     // Show a notification popup for the specified form vaidation messages
299     // besides the anchor rectangle. An implementation of this function should
300     // not hide the popup until hideValidationMessage call.
301     virtual void showValidationMessage(const WebRect& anchorInScreen, const WebString& mainText, const WebString& supplementalText, WebTextDirection hint) { }
302     // Hide notifation popup for form validation messages.
303     virtual void hideValidationMessage() { }
304
305     // Session history -----------------------------------------------------
306
307     // Tells the embedder to navigate back or forward in session history by
308     // the given offset (relative to the current position in session
309     // history).
310     virtual void navigateBackForwardSoon(int offset) { }
311
312     // Returns the number of history items before/after the current
313     // history item.
314     virtual int historyBackListCount() { return 0; }
315     virtual int historyForwardListCount() { return 0; }
316
317     // Called to notify the embedder when a new history item is added.
318     virtual void didAddHistoryItem() { }
319
320
321     // Accessibility -------------------------------------------------------
322
323     // Notifies embedder about an accessibility notification.
324     virtual void postAccessibilityNotification(const WebAccessibilityObject&, WebAccessibilityNotification) { }
325
326
327     // Developer tools -----------------------------------------------------
328
329     // Called to notify the client that the inspector's settings were
330     // changed and should be saved.  See WebView::inspectorSettings.
331     virtual void didUpdateInspectorSettings() { }
332
333     virtual void didUpdateInspectorSetting(const WebString& key, const WebString& value) { }
334
335     // Geolocation ---------------------------------------------------------
336
337     // Access the embedder API for (client-based) geolocation client .
338     virtual WebGeolocationClient* geolocationClient() { return 0; }
339     // Access the embedder API for (non-client-based) geolocation services.
340     virtual WebGeolocationService* geolocationService() { return 0; }
341
342     // Speech --------------------------------------------------------------
343
344     // Access the embedder API for speech input services.
345     virtual WebSpeechInputController* speechInputController(
346         WebSpeechInputListener*) { return 0; }
347
348     // Access the embedder API for speech recognition services.
349     virtual WebSpeechRecognizer* speechRecognizer() { return 0; }
350
351     // Device Orientation --------------------------------------------------
352
353     // Access the embedder API for device orientation services.
354     virtual WebDeviceOrientationClient* deviceOrientationClient() { return 0; }
355
356     // Battery Status ------------------------------------------------------
357
358     // Access the embedder API for battery status services.
359     virtual WebBatteryStatusClient* batteryStatusClient() { return 0; }
360
361     // Zoom ----------------------------------------------------------------
362
363     // Informs the browser that the zoom levels for this frame have changed from
364     // the default values.
365     virtual void zoomLimitsChanged(double minimumLevel, double maximumLevel) { }
366
367     // Informs the browser that the zoom level has changed as a result of an
368     // action that wasn't initiated by the client.
369     virtual void zoomLevelChanged() { }
370
371     // Registers a new URL handler for the given protocol.
372     virtual void registerProtocolHandler(const WebString& scheme,
373                                          const WebString& baseUrl,
374                                          const WebString& url,
375                                          const WebString& title) { }
376
377     // Visibility -----------------------------------------------------------
378
379     // Returns the current visibility of the WebView.
380     virtual WebPageVisibilityState visibilityState() const
381     {
382         return WebPageVisibilityStateVisible;
383     }
384
385     // Media Streams -------------------------------------------------------
386
387     virtual WebUserMediaClient* userMediaClient() { return 0; }
388
389
390     // Content detection ----------------------------------------------------
391
392     // Retrieves detectable content (e.g., email addresses, phone numbers)
393     // around a hit test result. The embedder should use platform-specific
394     // content detectors to analyze the region around the hit test result.
395     virtual WebContentDetectionResult detectContentAround(const WebHitTestResult&) { return WebContentDetectionResult(); }
396
397     // Schedules a new content intent with the provided url.
398     virtual void scheduleContentIntent(const WebURL&) { }
399
400     // Cancels any previously scheduled content intents that have not yet launched.
401     virtual void cancelScheduledContentIntents() { }
402
403     // Draggable regions ----------------------------------------------------
404
405     // Informs the browser that the draggable regions have been updated.
406     virtual void draggableRegionsChanged() { }
407
408 protected:
409     ~WebViewClient() { }
410 };
411
412 } // namespace WebKit
413
414 #endif