[email protected] | 4fdf674 | 2012-01-10 20:14:36 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
[email protected] | 674bc59 | 2011-12-20 23:00:42 | [diff] [blame] | 5 | #ifndef CONTENT_PUBLIC_BROWSER_WEB_CONTENTS_DELEGATE_H_ |
| 6 | #define CONTENT_PUBLIC_BROWSER_WEB_CONTENTS_DELEGATE_H_ |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 7 | |
[email protected] | 1de2b8b | 2011-06-29 19:38:46 | [diff] [blame] | 8 | #include <set> |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 9 | #include <string> |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 10 | |
| 11 | #include "base/basictypes.h" |
[email protected] | f13b420 | 2012-06-12 23:53:23 | [diff] [blame] | 12 | #include "base/callback.h" |
[email protected] | d583e3f2 | 2011-12-27 21:38:17 | [diff] [blame] | 13 | #include "base/string16.h" |
[email protected] | 8d128d6 | 2011-09-13 22:11:57 | [diff] [blame] | 14 | #include "content/common/content_export.h" |
[email protected] | e6e646d | 2011-12-01 00:50:11 | [diff] [blame] | 15 | #include "content/public/browser/navigation_type.h" |
[email protected] | f13b420 | 2012-06-12 23:53:23 | [diff] [blame] | 16 | #include "content/public/common/media_stream_request.h" |
[email protected] | 2905f74 | 2011-10-13 03:51:58 | [diff] [blame] | 17 | #include "content/public/common/page_transition_types.h" |
[email protected] | 4fdf674 | 2012-01-10 20:14:36 | [diff] [blame] | 18 | #include "content/public/common/window_container_type.h" |
[email protected] | da854376 | 2012-03-20 08:52:20 | [diff] [blame] | 19 | #include "third_party/skia/include/core/SkColor.h" |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 20 | #include "ui/gfx/native_widget_types.h" |
[email protected] | 59363fc9 | 2012-09-05 03:46:31 | [diff] [blame] | 21 | #include "ui/gfx/rect_f.h" |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 22 | #include "webkit/glue/window_open_disposition.h" |
| 23 | |
[email protected] | 7dba43dc | 2011-11-10 01:57:58 | [diff] [blame] | 24 | class FilePath; |
| 25 | class GURL; |
[email protected] | b172aee | 2012-04-10 17:05:26 | [diff] [blame] | 26 | class WebContentsImpl; |
[email protected] | 7dba43dc | 2011-11-10 01:57:58 | [diff] [blame] | 27 | |
[email protected] | 32ded221 | 2011-11-10 18:51:43 | [diff] [blame] | 28 | namespace base { |
| 29 | class ListValue; |
| 30 | } |
| 31 | |
[email protected] | 3ab9cb8 | 2011-06-03 18:02:07 | [diff] [blame] | 32 | namespace content { |
[email protected] | 3d7474ff | 2011-07-27 17:47:37 | [diff] [blame] | 33 | class BrowserContext; |
[email protected] | da854376 | 2012-03-20 08:52:20 | [diff] [blame] | 34 | class ColorChooser; |
[email protected] | e582fdd | 2011-12-20 16:48:17 | [diff] [blame] | 35 | class DownloadItem; |
[email protected] | 3ab9cb8 | 2011-06-03 18:02:07 | [diff] [blame] | 36 | class JavaScriptDialogCreator; |
[email protected] | c0c1c62 | 2012-03-13 04:51:54 | [diff] [blame] | 37 | class RenderViewHost; |
[email protected] | a81343d23 | 2011-12-27 07:39:20 | [diff] [blame] | 38 | class WebContents; |
[email protected] | 0d9989d | 2011-12-21 20:26:00 | [diff] [blame] | 39 | class WebIntentsDispatcher; |
[email protected] | 35be7ec | 2012-02-12 20:42:51 | [diff] [blame] | 40 | struct ContextMenuParams; |
[email protected] | e582fdd | 2011-12-20 16:48:17 | [diff] [blame] | 41 | struct FileChooserParams; |
[email protected] | b87ee52 | 2012-05-18 15:16:54 | [diff] [blame] | 42 | struct NativeWebKeyboardEvent; |
[email protected] | d583e3f2 | 2011-12-27 21:38:17 | [diff] [blame] | 43 | struct SSLStatus; |
[email protected] | 3ab9cb8 | 2011-06-03 18:02:07 | [diff] [blame] | 44 | } |
| 45 | |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 46 | namespace gfx { |
| 47 | class Point; |
| 48 | class Rect; |
| 49 | class Size; |
| 50 | } |
| 51 | |
| 52 | namespace history { |
| 53 | class HistoryAddPageArgs; |
| 54 | } |
| 55 | |
[email protected] | ce975194 | 2011-09-21 01:57:24 | [diff] [blame] | 56 | namespace webkit_glue { |
| 57 | struct WebIntentData; |
[email protected] | 3a3b75a | 2012-06-01 08:38:36 | [diff] [blame] | 58 | struct WebIntentServiceData; |
[email protected] | ce975194 | 2011-09-21 01:57:24 | [diff] [blame] | 59 | } |
| 60 | |
[email protected] | 1638338 | 2012-09-05 23:57:26 | [diff] [blame^] | 61 | namespace WebKit { |
| 62 | class WebLayer; |
| 63 | } |
| 64 | |
[email protected] | 674bc59 | 2011-12-20 23:00:42 | [diff] [blame] | 65 | namespace content { |
| 66 | |
[email protected] | e5d549d | 2011-12-28 01:29:20 | [diff] [blame] | 67 | struct OpenURLParams; |
| 68 | |
[email protected] | f13b420 | 2012-06-12 23:53:23 | [diff] [blame] | 69 | typedef base::Callback< void(const MediaStreamDevices&) > MediaResponseCallback; |
| 70 | |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 71 | // Objects implement this interface to get notified about changes in the |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 72 | // WebContents and to provide necessary functionality. |
[email protected] | 674bc59 | 2011-12-20 23:00:42 | [diff] [blame] | 73 | class CONTENT_EXPORT WebContentsDelegate { |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 74 | public: |
[email protected] | 674bc59 | 2011-12-20 23:00:42 | [diff] [blame] | 75 | WebContentsDelegate(); |
[email protected] | 1de2b8b | 2011-06-29 19:38:46 | [diff] [blame] | 76 | |
[email protected] | e5d549d | 2011-12-28 01:29:20 | [diff] [blame] | 77 | // Opens a new URL inside the passed in WebContents (if source is 0 open |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 78 | // in the current front-most tab), unless |disposition| indicates the url |
| 79 | // should be opened in a new tab or window. |
| 80 | // |
| 81 | // A NULL source indicates the current tab (callers should probably use |
| 82 | // OpenURL() for these cases which does it for you). |
[email protected] | 00c37fc | 2011-08-02 00:22:50 | [diff] [blame] | 83 | |
[email protected] | e5d549d | 2011-12-28 01:29:20 | [diff] [blame] | 84 | // Returns the WebContents the URL is opened in, or NULL if the URL wasn't |
[email protected] | 992e454 | 2011-07-20 23:09:25 | [diff] [blame] | 85 | // opened immediately. |
[email protected] | e5d549d | 2011-12-28 01:29:20 | [diff] [blame] | 86 | virtual WebContents* OpenURLFromTab(WebContents* source, |
[email protected] | 00c37fc | 2011-08-02 00:22:50 | [diff] [blame] | 87 | const OpenURLParams& params); |
| 88 | |
[email protected] | ca13a44 | 2012-04-17 14:00:12 | [diff] [blame] | 89 | // Called to inform the delegate that the WebContents's navigation state |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 90 | // changed. The |changed_flags| indicates the parts of the navigation state |
| 91 | // that have been updated, and is any combination of the |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 92 | // |WebContents::InvalidateTypes| bits. |
| 93 | virtual void NavigationStateChanged(const WebContents* source, |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 94 | unsigned changed_flags) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 95 | |
[email protected] | 6c6b02d | 2011-09-02 03:36:47 | [diff] [blame] | 96 | // Adds the navigation request headers to |headers|. Use |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 97 | // net::HttpUtil::AppendHeaderIfMissing to build the set of headers. |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 98 | virtual void AddNavigationHeaders(const GURL& url, std::string* headers) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 99 | |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 100 | // Creates a new tab with the already-created WebContents 'new_contents'. |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 101 | // The window for the added contents should be reparented correctly when this |
| 102 | // method returns. If |disposition| is NEW_POPUP, |pos| should hold the |
| 103 | // initial position. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 104 | virtual void AddNewContents(WebContents* source, |
| 105 | WebContents* new_contents, |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 106 | WindowOpenDisposition disposition, |
| 107 | const gfx::Rect& initial_pos, |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 108 | bool user_gesture) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 109 | |
| 110 | // Selects the specified contents, bringing its container to the front. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 111 | virtual void ActivateContents(WebContents* contents) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 112 | |
| 113 | // Deactivates the specified contents by deactivating its container and |
| 114 | // potentialy moving it to the back of the Z order. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 115 | virtual void DeactivateContents(WebContents* contents) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 116 | |
| 117 | // Notifies the delegate that this contents is starting or is done loading |
| 118 | // some resource. The delegate should use this notification to represent |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 119 | // loading feedback. See WebContents::IsLoading() |
| 120 | virtual void LoadingStateChanged(WebContents* source) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 121 | |
| 122 | // Notifies the delegate that the page has made some progress loading. |
| 123 | // |progress| is a value between 0.0 (nothing loaded) to 1.0 (page fully |
| 124 | // loaded). |
| 125 | // Note that to receive this notification, you must have called |
| 126 | // SetReportLoadProgressEnabled(true) in the render view. |
[email protected] | b3996ba | 2012-08-08 00:39:13 | [diff] [blame] | 127 | virtual void LoadProgressChanged(WebContents* source, |
| 128 | double progress) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 129 | |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 130 | // Request the delegate to close this web contents, and do whatever cleanup |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 131 | // it needs to do. |
[email protected] | a81343d23 | 2011-12-27 07:39:20 | [diff] [blame] | 132 | virtual void CloseContents(WebContents* source) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 133 | |
[email protected] | cd9ed79d | 2011-11-15 19:22:57 | [diff] [blame] | 134 | // Informs the delegate that the underlying RenderViewHost has been swapped |
| 135 | // out so it can perform any cleanup necessary. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 136 | virtual void SwappedOut(WebContents* source) {} |
[email protected] | cd9ed79d | 2011-11-15 19:22:57 | [diff] [blame] | 137 | |
[email protected] | ca13a44 | 2012-04-17 14:00:12 | [diff] [blame] | 138 | // Request the delegate to move this WebContents to the specified position |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 139 | // in screen coordinates. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 140 | virtual void MoveContents(WebContents* source, const gfx::Rect& pos) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 141 | |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 142 | // Called to determine if the WebContents is contained in a popup window |
[email protected] | b35b26b3 | 2011-05-05 20:35:14 | [diff] [blame] | 143 | // or a panel window. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 144 | virtual bool IsPopupOrPanel(const WebContents* source) const; |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 145 | |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 146 | // Notification that the target URL has changed. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 147 | virtual void UpdateTargetURL(WebContents* source, |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 148 | int32 page_id, |
| 149 | const GURL& url) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 150 | |
| 151 | // Notification that there was a mouse event, along with the absolute |
| 152 | // coordinates of the mouse pointer and whether it was a normal motion event |
| 153 | // (otherwise, the pointer left the contents area). |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 154 | virtual void ContentsMouseEvent(WebContents* source, |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 155 | const gfx::Point& location, |
| 156 | bool motion) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 157 | |
| 158 | // Request the delegate to change the zoom level of the current tab. |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 159 | virtual void ContentsZoomChange(bool zoom_in) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 160 | |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 161 | // Check whether this contents is inside a window dedicated to running a web |
| 162 | // application. |
| 163 | virtual bool IsApplication() const; |
| 164 | |
[email protected] | 24e1825 | 2012-04-16 21:26:27 | [diff] [blame] | 165 | // Check whether this contents is permitted to load data URLs in WebUI mode. |
| 166 | // This is normally disallowed for security. |
| 167 | virtual bool CanLoadDataURLsInWebUI() const; |
| 168 | |
[email protected] | b7a756d4 | 2012-01-23 18:08:17 | [diff] [blame] | 169 | // Return the rect where to display the resize corner, if any, otherwise |
| 170 | // an empty rect. |
| 171 | virtual gfx::Rect GetRootWindowResizerRect() const; |
| 172 | |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 173 | // Invoked prior to showing before unload handler confirmation dialog. |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 174 | virtual void WillRunBeforeUnloadConfirm() {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 175 | |
| 176 | // Returns true if javascript dialogs and unload alerts are suppressed. |
| 177 | // Default is false. |
| 178 | virtual bool ShouldSuppressDialogs(); |
| 179 | |
[email protected] | a796f20 | 2012-05-30 14:14:25 | [diff] [blame] | 180 | // Add a message to the console. Returning true indicates that the delegate |
| 181 | // handled the message. If false is returned the default logging mechanism |
| 182 | // will be used for the message. |
| 183 | virtual bool AddMessageToConsole(WebContents* soruce, |
| 184 | int32 level, |
| 185 | const string16& message, |
| 186 | int32 line_no, |
| 187 | const string16& source_id); |
| 188 | |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 189 | // Tells us that we've finished firing this tab's beforeunload event. |
| 190 | // The proceed bool tells us whether the user chose to proceed closing the |
[email protected] | a2c92a1c | 2012-04-03 12:32:14 | [diff] [blame] | 191 | // tab. Returns true if the tab can continue on firing its unload event. |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 192 | // If we're closing the entire browser, then we'll want to delay firing |
| 193 | // unload events until all the beforeunload events have fired. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 194 | virtual void BeforeUnloadFired(WebContents* tab, |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 195 | bool proceed, |
| 196 | bool* proceed_to_fire_unload); |
| 197 | |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 198 | // Sets focus to the location bar or some other place that is appropriate. |
| 199 | // This is called when the tab wants to encourage user input, like for the |
| 200 | // new tab page. |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 201 | virtual void SetFocusToLocationBar(bool select_all) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 202 | |
| 203 | // Returns whether the page should be focused when transitioning from crashed |
| 204 | // to live. Default is true. |
| 205 | virtual bool ShouldFocusPageAfterCrash(); |
| 206 | |
| 207 | // Called when a popup select is about to be displayed. The delegate can use |
| 208 | // this to disable inactive rendering for the frame in the window the select |
| 209 | // is opened within if necessary. |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 210 | virtual void RenderWidgetShowing() {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 211 | |
| 212 | // This is called when WebKit tells us that it is done tabbing through |
[email protected] | 674bc59 | 2011-12-20 23:00:42 | [diff] [blame] | 213 | // controls on the page. Provides a way for WebContentsDelegates to handle |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 214 | // this. Returns true if the delegate successfully handled it. |
[email protected] | b3996ba | 2012-08-08 00:39:13 | [diff] [blame] | 215 | virtual bool TakeFocus(WebContents* soruce, |
| 216 | bool reverse); |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 217 | |
| 218 | // Invoked when the page loses mouse capture. |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 219 | virtual void LostCapture() {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 220 | |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 221 | // Notification that |contents| has gained focus. |
| 222 | virtual void WebContentsFocused(WebContents* contents) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 223 | |
[email protected] | 68649314 | 2011-07-15 21:47:22 | [diff] [blame] | 224 | // Asks the delegate if the given tab can download. |
[email protected] | c0c1c62 | 2012-03-13 04:51:54 | [diff] [blame] | 225 | virtual bool CanDownload(RenderViewHost* render_view_host, |
| 226 | int request_id, |
| 227 | const std::string& request_method); |
[email protected] | 68649314 | 2011-07-15 21:47:22 | [diff] [blame] | 228 | |
| 229 | // Notifies the delegate that a download is starting. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 230 | virtual void OnStartDownload(WebContents* source, DownloadItem* download) {} |
[email protected] | 68649314 | 2011-07-15 21:47:22 | [diff] [blame] | 231 | |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 232 | // Return much extra vertical space should be allotted to the |
| 233 | // render view widget during various animations (e.g. infobar closing). |
| 234 | // This is used to make painting look smoother. |
| 235 | virtual int GetExtraRenderViewHeight() const; |
| 236 | |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 237 | // Returns true if the context menu operation was handled by the delegate. |
[email protected] | 35be7ec | 2012-02-12 20:42:51 | [diff] [blame] | 238 | virtual bool HandleContextMenu(const content::ContextMenuParams& params); |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 239 | |
| 240 | // Returns true if the context menu command was handled |
| 241 | virtual bool ExecuteContextMenuCommand(int command); |
| 242 | |
[email protected] | ca13a44 | 2012-04-17 14:00:12 | [diff] [blame] | 243 | // Opens source view for given WebContents that is navigated to the given |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 244 | // page url. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 245 | virtual void ViewSourceForTab(WebContents* source, const GURL& page_url); |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 246 | |
[email protected] | 932b7a1 | 2011-03-09 12:50:27 | [diff] [blame] | 247 | // Opens source view for the given subframe. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 248 | virtual void ViewSourceForFrame(WebContents* source, |
[email protected] | 932b7a1 | 2011-03-09 12:50:27 | [diff] [blame] | 249 | const GURL& url, |
| 250 | const std::string& content_state); |
| 251 | |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 252 | // Allows delegates to handle keyboard events before sending to the renderer. |
| 253 | // Returns true if the |event| was handled. Otherwise, if the |event| would be |
| 254 | // handled in HandleKeyboardEvent() method as a normal keyboard shortcut, |
| 255 | // |*is_keyboard_shortcut| should be set to true. |
[email protected] | b3996ba | 2012-08-08 00:39:13 | [diff] [blame] | 256 | virtual bool PreHandleKeyboardEvent(WebContents* source, |
| 257 | const NativeWebKeyboardEvent& event, |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 258 | bool* is_keyboard_shortcut); |
| 259 | |
| 260 | // Allows delegates to handle unhandled keyboard messages coming back from |
| 261 | // the renderer. |
[email protected] | b3996ba | 2012-08-08 00:39:13 | [diff] [blame] | 262 | virtual void HandleKeyboardEvent(WebContents* source, |
| 263 | const NativeWebKeyboardEvent& event) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 264 | |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 265 | virtual void HandleMouseDown() {} |
| 266 | virtual void HandleMouseUp() {} |
[email protected] | 590a634e | 2012-07-19 16:38:23 | [diff] [blame] | 267 | |
| 268 | // Handles activation resulting from a pointer event (e.g. when mouse is |
| 269 | // pressed, or a touch-gesture begins). |
| 270 | virtual void HandlePointerActivate() {} |
| 271 | |
| 272 | virtual void HandleGestureBegin() {} |
| 273 | virtual void HandleGestureEnd() {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 274 | |
| 275 | // Render view drag n drop ended. |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 276 | virtual void DragEnded() {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 277 | |
| 278 | // Shows the repost form confirmation dialog box. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 279 | virtual void ShowRepostFormWarningDialog(WebContents* source) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 280 | |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 281 | // Allows delegate to override navigation to the history entries. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 282 | // Returns true to allow WebContents to continue with the default processing. |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 283 | virtual bool OnGoToEntryOffset(int offset); |
| 284 | |
[email protected] | ca13a44 | 2012-04-17 14:00:12 | [diff] [blame] | 285 | // Returns whether this WebContents should add the specified navigation to |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 286 | // history. |
| 287 | virtual bool ShouldAddNavigationToHistory( |
| 288 | const history::HistoryAddPageArgs& add_page_args, |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 289 | NavigationType navigation_type); |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 290 | |
[email protected] | ca13a44 | 2012-04-17 14:00:12 | [diff] [blame] | 291 | // Returns the native window framing the view containing the WebContents. |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 292 | virtual gfx::NativeWindow GetFrameNativeWindow(); |
| 293 | |
[email protected] | 4fdf674 | 2012-01-10 20:14:36 | [diff] [blame] | 294 | // Allows delegate to control whether a WebContents will be created. Returns |
[email protected] | 03b6d55 | 2012-03-29 04:03:01 | [diff] [blame] | 295 | // true to allow the creation. Default is to allow it. In cases where the |
| 296 | // delegate handles the creation/navigation itself, it will use |target_url|. |
[email protected] | 4fdf674 | 2012-01-10 20:14:36 | [diff] [blame] | 297 | virtual bool ShouldCreateWebContents( |
| 298 | WebContents* web_contents, |
| 299 | int route_id, |
| 300 | WindowContainerType window_container_type, |
[email protected] | 03b6d55 | 2012-03-29 04:03:01 | [diff] [blame] | 301 | const string16& frame_name, |
| 302 | const GURL& target_url); |
[email protected] | 4fdf674 | 2012-01-10 20:14:36 | [diff] [blame] | 303 | |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 304 | // Notifies the delegate about the creation of a new WebContents. This |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 305 | // typically happens when popups are created. |
[email protected] | 4fdf674 | 2012-01-10 20:14:36 | [diff] [blame] | 306 | virtual void WebContentsCreated(WebContents* source_contents, |
| 307 | int64 source_frame_id, |
| 308 | const GURL& target_url, |
| 309 | WebContents* new_contents) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 310 | |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 311 | // Notifies the delegate that the content restrictions for this tab has |
| 312 | // changed. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 313 | virtual void ContentRestrictionsChanged(WebContents* source) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 314 | |
[email protected] | 5545290 | 2011-06-01 21:57:47 | [diff] [blame] | 315 | // Notification that the tab is hung. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 316 | virtual void RendererUnresponsive(WebContents* source) {} |
[email protected] | 5545290 | 2011-06-01 21:57:47 | [diff] [blame] | 317 | |
| 318 | // Notification that the tab is no longer hung. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 319 | virtual void RendererResponsive(WebContents* source) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 320 | |
| 321 | // Notification that a worker associated with this tab has crashed. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 322 | virtual void WorkerCrashed(WebContents* source) {} |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 323 | |
[email protected] | 09b2934 | 2011-06-24 19:18:48 | [diff] [blame] | 324 | // Invoked when a main fram navigation occurs. |
[email protected] | 3bbacc5b | 2012-04-17 17:46:15 | [diff] [blame] | 325 | virtual void DidNavigateMainFramePostCommit(WebContents* source) {} |
[email protected] | 93f230e0 | 2011-06-01 14:40:00 | [diff] [blame] | 326 | |
[email protected] | 09b2934 | 2011-06-24 19:18:48 | [diff] [blame] | 327 | // Invoked when navigating to a pending entry. When invoked the |
| 328 | // NavigationController has configured its pending entry, but it has not yet |
| 329 | // been committed. |
[email protected] | 3bbacc5b | 2012-04-17 17:46:15 | [diff] [blame] | 330 | virtual void DidNavigateToPendingEntry(WebContents* source) {} |
[email protected] | 93f230e0 | 2011-06-01 14:40:00 | [diff] [blame] | 331 | |
[email protected] | 51da7e3 | 2012-01-30 19:24:52 | [diff] [blame] | 332 | // Returns a pointer to a service to create JavaScript dialogs. May return |
| 333 | // NULL in which case dialogs aren't shown. |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 334 | virtual JavaScriptDialogCreator* GetJavaScriptDialogCreator(); |
[email protected] | 3ab9cb8 | 2011-06-03 18:02:07 | [diff] [blame] | 335 | |
[email protected] | da854376 | 2012-03-20 08:52:20 | [diff] [blame] | 336 | // Called when color chooser should open. Returns the opened color chooser. |
[email protected] | 3bbacc5b | 2012-04-17 17:46:15 | [diff] [blame] | 337 | virtual content::ColorChooser* OpenColorChooser(WebContents* web_contents, |
[email protected] | da854376 | 2012-03-20 08:52:20 | [diff] [blame] | 338 | int color_chooser_id, |
[email protected] | 55578b0a | 2012-04-18 14:31:32 | [diff] [blame] | 339 | SkColor color); |
[email protected] | da854376 | 2012-03-20 08:52:20 | [diff] [blame] | 340 | |
| 341 | virtual void DidEndColorChooser() {} |
| 342 | |
[email protected] | 3a29a6e | 2011-08-24 18:26:21 | [diff] [blame] | 343 | // Called when a file selection is to be done. |
[email protected] | 3bbacc5b | 2012-04-17 17:46:15 | [diff] [blame] | 344 | virtual void RunFileChooser(WebContents* web_contents, |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 345 | const FileChooserParams& params) {} |
[email protected] | 3a29a6e | 2011-08-24 18:26:21 | [diff] [blame] | 346 | |
| 347 | // Request to enumerate a directory. This is equivalent to running the file |
| 348 | // chooser in directory-enumeration mode and having the user select the given |
| 349 | // directory. |
[email protected] | 3bbacc5b | 2012-04-17 17:46:15 | [diff] [blame] | 350 | virtual void EnumerateDirectory(WebContents* web_contents, |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 351 | int request_id, |
| 352 | const FilePath& path) {} |
[email protected] | 3a29a6e | 2011-08-24 18:26:21 | [diff] [blame] | 353 | |
[email protected] | 8a5e0ca | 2011-08-25 06:30:47 | [diff] [blame] | 354 | // Called when the renderer puts a tab into or out of fullscreen mode. |
[email protected] | 3bbacc5b | 2012-04-17 17:46:15 | [diff] [blame] | 355 | virtual void ToggleFullscreenModeForTab(WebContents* web_contents, |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 356 | bool enter_fullscreen) {} |
[email protected] | 3bbacc5b | 2012-04-17 17:46:15 | [diff] [blame] | 357 | virtual bool IsFullscreenForTabOrPending( |
| 358 | const WebContents* web_contents) const; |
[email protected] | 8a5e0ca | 2011-08-25 06:30:47 | [diff] [blame] | 359 | |
[email protected] | 7d18902 | 2011-08-25 22:54:20 | [diff] [blame] | 360 | // Called when a Javascript out of memory notification is received. |
[email protected] | 3bbacc5b | 2012-04-17 17:46:15 | [diff] [blame] | 361 | virtual void JSOutOfMemory(WebContents* web_contents) {} |
[email protected] | 7d18902 | 2011-08-25 22:54:20 | [diff] [blame] | 362 | |
| 363 | // Register a new handler for URL requests with the given scheme. |
[email protected] | 3a3b75a | 2012-06-01 08:38:36 | [diff] [blame] | 364 | // |user_gesture| is true if the registration is made in the context of a user |
| 365 | // gesture. |
[email protected] | 3bbacc5b | 2012-04-17 17:46:15 | [diff] [blame] | 366 | virtual void RegisterProtocolHandler(WebContents* web_contents, |
[email protected] | 7d18902 | 2011-08-25 22:54:20 | [diff] [blame] | 367 | const std::string& protocol, |
| 368 | const GURL& url, |
[email protected] | 3a3b75a | 2012-06-01 08:38:36 | [diff] [blame] | 369 | const string16& title, |
| 370 | bool user_gesture) {} |
[email protected] | 7d18902 | 2011-08-25 22:54:20 | [diff] [blame] | 371 | |
[email protected] | 3a3b75a | 2012-06-01 08:38:36 | [diff] [blame] | 372 | // Register a new Web Intents service. |
| 373 | // |user_gesture| is true if the registration is made in the context of a user |
| 374 | // gesture. |web_contents| is the context in which the registration was |
| 375 | // performed, and |data| is the service record being registered. |
| 376 | virtual void RegisterIntentHandler( |
| 377 | WebContents* web_contents, |
| 378 | const webkit_glue::WebIntentServiceData& data, |
| 379 | bool user_gesture) {} |
[email protected] | 7d18902 | 2011-08-25 22:54:20 | [diff] [blame] | 380 | |
[email protected] | 0b5af6f | 2012-02-03 23:14:16 | [diff] [blame] | 381 | // Web Intents notification handler. See WebIntentsDispatcher for |
| 382 | // documentation of callee responsibility for the dispatcher. |
[email protected] | 3bbacc5b | 2012-04-17 17:46:15 | [diff] [blame] | 383 | virtual void WebIntentDispatch(WebContents* web_contents, |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 384 | WebIntentsDispatcher* intents_dispatcher); |
[email protected] | 7d18902 | 2011-08-25 22:54:20 | [diff] [blame] | 385 | |
[email protected] | b888919c | 2011-09-02 00:32:16 | [diff] [blame] | 386 | // Result of string search in the page. This includes the number of matches |
| 387 | // found and the selection rect (in screen coordinates) for the string found. |
| 388 | // If |final_update| is false, it indicates that more results follow. |
[email protected] | 3bbacc5b | 2012-04-17 17:46:15 | [diff] [blame] | 389 | virtual void FindReply(WebContents* web_contents, |
[email protected] | b888919c | 2011-09-02 00:32:16 | [diff] [blame] | 390 | int request_id, |
| 391 | int number_of_matches, |
| 392 | const gfx::Rect& selection_rect, |
| 393 | int active_match_ordinal, |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 394 | bool final_update) {} |
[email protected] | b888919c | 2011-09-02 00:32:16 | [diff] [blame] | 395 | |
[email protected] | 59363fc9 | 2012-09-05 03:46:31 | [diff] [blame] | 396 | #if defined(OS_ANDROID) |
| 397 | // Provides the rects of the current find-in-page matches. |
| 398 | // Sent as a reply to RequestFindMatchRects. |
| 399 | virtual void FindMatchRectsReply(WebContents* web_contents, |
| 400 | int version, |
| 401 | const std::vector<gfx::RectF>& rects, |
| 402 | const gfx::RectF& active_rect) {} |
| 403 | #endif |
| 404 | |
[email protected] | 0548c535 | 2011-09-07 00:33:33 | [diff] [blame] | 405 | // Invoked when the preferred size of the contents has been changed. |
[email protected] | 3bbacc5b | 2012-04-17 17:46:15 | [diff] [blame] | 406 | virtual void UpdatePreferredSize(WebContents* web_contents, |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 407 | const gfx::Size& pref_size) {} |
[email protected] | 0548c535 | 2011-09-07 00:33:33 | [diff] [blame] | 408 | |
[email protected] | 61e2b3cc | 2012-03-02 16:13:34 | [diff] [blame] | 409 | // Invoked when the contents auto-resized and the container should match it. |
[email protected] | 3bbacc5b | 2012-04-17 17:46:15 | [diff] [blame] | 410 | virtual void ResizeDueToAutoResize(WebContents* web_contents, |
[email protected] | 61e2b3cc | 2012-03-02 16:13:34 | [diff] [blame] | 411 | const gfx::Size& new_size) {} |
| 412 | |
[email protected] | 32ded221 | 2011-11-10 18:51:43 | [diff] [blame] | 413 | // Notification message from HTML UI. |
[email protected] | 3bbacc5b | 2012-04-17 17:46:15 | [diff] [blame] | 414 | virtual void WebUISend(WebContents* web_contents, |
[email protected] | 32ded221 | 2011-11-10 18:51:43 | [diff] [blame] | 415 | const GURL& source_url, |
| 416 | const std::string& name, |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 417 | const base::ListValue& args) {} |
[email protected] | 32ded221 | 2011-11-10 18:51:43 | [diff] [blame] | 418 | |
[email protected] | e962111 | 2011-10-17 05:38:37 | [diff] [blame] | 419 | // Requests to lock the mouse. Once the request is approved or rejected, |
| 420 | // GotResponseToLockMouseRequest() will be called on the requesting tab |
| 421 | // contents. |
[email protected] | 42252e0 | 2012-04-26 16:29:39 | [diff] [blame] | 422 | virtual void RequestToLockMouse(WebContents* web_contents, |
[email protected] | a9c81f0 | 2012-06-01 00:15:44 | [diff] [blame] | 423 | bool user_gesture, |
[email protected] | f13b420 | 2012-06-12 23:53:23 | [diff] [blame] | 424 | bool last_unlocked_by_target) {} |
[email protected] | e962111 | 2011-10-17 05:38:37 | [diff] [blame] | 425 | |
| 426 | // Notification that the page has lost the mouse lock. |
[email protected] | 229eb7e | 2011-12-23 01:04:08 | [diff] [blame] | 427 | virtual void LostMouseLock() {} |
[email protected] | e962111 | 2011-10-17 05:38:37 | [diff] [blame] | 428 | |
[email protected] | f13b420 | 2012-06-12 23:53:23 | [diff] [blame] | 429 | // Asks permission to use the camera and/or microphone. If permission is |
| 430 | // granted, a call should be made to |callback| with the devices. If the |
| 431 | // request is denied, a call should be made to |callback| with an empty list |
| 432 | // of devices. |request| has the details of the request (e.g. which of audio |
| 433 | // and/or video devices are requested, and lists of available devices). |
| 434 | virtual void RequestMediaAccessPermission( |
| 435 | WebContents* web_contents, |
| 436 | const MediaStreamRequest* request, |
| 437 | const MediaResponseCallback& callback) {} |
| 438 | |
[email protected] | 1638338 | 2012-09-05 23:57:26 | [diff] [blame^] | 439 | #if defined(OS_ANDROID) |
| 440 | // Returns true if the delegate wants to handle the url instead. Default |
| 441 | // returns false. |
| 442 | virtual bool ShouldOverrideLoading(const GURL& url); |
| 443 | |
| 444 | // Called when a compositing layer becomes available for this web contents |
| 445 | // so the delegate can add it to the layer tree. |
| 446 | virtual void AttachLayer(WebContents* web_contents, |
| 447 | WebKit::WebLayer* layer) {} |
| 448 | |
| 449 | // Called before a compositing layer becomes invalid so the delegate can |
| 450 | // remove it from the layer tree. |
| 451 | virtual void RemoveLayer(WebContents* web_contents, |
| 452 | WebKit::WebLayer* layer) {} |
| 453 | #endif |
| 454 | |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 455 | protected: |
[email protected] | 674bc59 | 2011-12-20 23:00:42 | [diff] [blame] | 456 | virtual ~WebContentsDelegate(); |
[email protected] | 1de2b8b | 2011-06-29 19:38:46 | [diff] [blame] | 457 | |
| 458 | private: |
[email protected] | b172aee | 2012-04-10 17:05:26 | [diff] [blame] | 459 | friend class ::WebContentsImpl; |
[email protected] | 1de2b8b | 2011-06-29 19:38:46 | [diff] [blame] | 460 | |
[email protected] | 674bc59 | 2011-12-20 23:00:42 | [diff] [blame] | 461 | // Called when |this| becomes the WebContentsDelegate for |source|. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 462 | void Attach(WebContents* source); |
[email protected] | 1de2b8b | 2011-06-29 19:38:46 | [diff] [blame] | 463 | |
[email protected] | 674bc59 | 2011-12-20 23:00:42 | [diff] [blame] | 464 | // Called when |this| is no longer the WebContentsDelegate for |source|. |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 465 | void Detach(WebContents* source); |
[email protected] | 1de2b8b | 2011-06-29 19:38:46 | [diff] [blame] | 466 | |
[email protected] | 2a6bc3e | 2011-12-28 23:51:33 | [diff] [blame] | 467 | // The WebContents that this is currently a delegate for. |
| 468 | std::set<WebContents*> attached_contents_; |
[email protected] | 0dd3a0ab | 2011-02-18 08:17:44 | [diff] [blame] | 469 | }; |
| 470 | |
[email protected] | 674bc59 | 2011-12-20 23:00:42 | [diff] [blame] | 471 | } // namespace content |
| 472 | |
| 473 | #endif // CONTENT_PUBLIC_BROWSER_WEB_CONTENTS_DELEGATE_H_ |