| OLD | NEW |
| (Empty) |
| 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | |
| 2 // Use of this source code is governed by a BSD-style license that can be | |
| 3 // found in the LICENSE file. | |
| 4 | |
| 5 #ifndef CHROME_BROWSER_UI_WEBUI_WEB_DIALOG_DELEGATE_H_ | |
| 6 #define CHROME_BROWSER_UI_WEBUI_WEB_DIALOG_DELEGATE_H_ | |
| 7 #pragma once | |
| 8 | |
| 9 #include <string> | |
| 10 #include <vector> | |
| 11 | |
| 12 #include "base/string16.h" | |
| 13 #include "ui/base/ui_base_types.h" | |
| 14 #include "webkit/glue/window_open_disposition.h" | |
| 15 | |
| 16 class GURL; | |
| 17 | |
| 18 namespace content { | |
| 19 class RenderViewHost; | |
| 20 class WebContents; | |
| 21 class WebUI; | |
| 22 class WebUIMessageHandler; | |
| 23 struct ContextMenuParams; | |
| 24 struct OpenURLParams; | |
| 25 } | |
| 26 | |
| 27 namespace gfx { | |
| 28 class Rect; | |
| 29 class Size; | |
| 30 } | |
| 31 | |
| 32 // Implement this class to receive notifications. | |
| 33 class WebDialogDelegate { | |
| 34 public: | |
| 35 // Returns true if the contents needs to be run in a modal dialog. | |
| 36 virtual ui::ModalType GetDialogModalType() const = 0; | |
| 37 | |
| 38 // Returns the title of the dialog. | |
| 39 virtual string16 GetDialogTitle() const = 0; | |
| 40 | |
| 41 // Returns the dialog's name identifier. Used to identify this dialog for | |
| 42 // state restoration. | |
| 43 virtual std::string GetDialogName() const; | |
| 44 | |
| 45 // Get the HTML file path for the content to load in the dialog. | |
| 46 virtual GURL GetDialogContentURL() const = 0; | |
| 47 | |
| 48 // Get WebUIMessageHandler objects to handle messages from the HTML/JS page. | |
| 49 // The handlers are used to send and receive messages from the page while it | |
| 50 // is still open. Ownership of each handler is taken over by the WebUI | |
| 51 // hosting the page. | |
| 52 virtual void GetWebUIMessageHandlers( | |
| 53 std::vector<content::WebUIMessageHandler*>* handlers) const = 0; | |
| 54 | |
| 55 // Get the size of the dialog. | |
| 56 virtual void GetDialogSize(gfx::Size* size) const = 0; | |
| 57 | |
| 58 // Get the size of the dialog. | |
| 59 virtual void GetMinimumDialogSize(gfx::Size* size) const; | |
| 60 | |
| 61 // Gets the JSON string input to use when showing the dialog. | |
| 62 virtual std::string GetDialogArgs() const = 0; | |
| 63 | |
| 64 // A callback to notify the delegate that |source|'s loading state has | |
| 65 // changed. | |
| 66 virtual void OnLoadingStateChanged(content::WebContents* source) {} | |
| 67 | |
| 68 // A callback to notify the delegate that a web dialog has been shown. | |
| 69 // |webui| is the WebUI with which the dialog is associated. | |
| 70 // |render_view_host| is the RenderViewHost for the shown dialog. | |
| 71 virtual void OnDialogShown(content::WebUI* webui, | |
| 72 content::RenderViewHost* render_view_host) {} | |
| 73 | |
| 74 // A callback to notify the delegate that the dialog closed. | |
| 75 // IMPORTANT: Implementations should delete |this| here (unless they've | |
| 76 // arranged for the delegate to be deleted in some other way, e.g. by | |
| 77 // registering it as a message handler in the WebUI object). | |
| 78 virtual void OnDialogClosed(const std::string& json_retval) = 0; | |
| 79 | |
| 80 // A callback to notify the delegate that the contents have gone | |
| 81 // away. Only relevant if your dialog hosts code that calls | |
| 82 // windows.close() and you've allowed that. If the output parameter | |
| 83 // is set to true, then the dialog is closed. The default is false. | |
| 84 virtual void OnCloseContents(content::WebContents* source, | |
| 85 bool* out_close_dialog) = 0; | |
| 86 | |
| 87 // A callback to allow the delegate to dictate that the window should not | |
| 88 // have a title bar. This is useful when presenting branded interfaces. | |
| 89 virtual bool ShouldShowDialogTitle() const = 0; | |
| 90 | |
| 91 // A callback to allow the delegate to inhibit context menu or show | |
| 92 // customized menu. | |
| 93 // Returns true iff you do NOT want the standard context menu to be | |
| 94 // shown (because you want to handle it yourself). | |
| 95 virtual bool HandleContextMenu(const content::ContextMenuParams& params); | |
| 96 | |
| 97 // A callback to allow the delegate to open a new URL inside |source|. | |
| 98 // On return |out_new_contents| should contain the WebContents the URL | |
| 99 // is opened in. Return false to use the default handler. | |
| 100 virtual bool HandleOpenURLFromTab(content::WebContents* source, | |
| 101 const content::OpenURLParams& params, | |
| 102 content::WebContents** out_new_contents); | |
| 103 | |
| 104 // A callback to create a new tab with |new_contents|. |source| is the | |
| 105 // WebContent where the operation originated. |disposition| controls how the | |
| 106 // new tab should be opened. |initial_pos| is the position of the window if a | |
| 107 // new window is created. |user_gesture| is true if the operation was started | |
| 108 // by a user gesture. Return false to use the default handler. | |
| 109 virtual bool HandleAddNewContents(content::WebContents* source, | |
| 110 content::WebContents* new_contents, | |
| 111 WindowOpenDisposition disposition, | |
| 112 const gfx::Rect& initial_pos, | |
| 113 bool user_gesture); | |
| 114 | |
| 115 // Stores the dialog bounds. | |
| 116 virtual void StoreDialogSize(const gfx::Size& dialog_size) {} | |
| 117 | |
| 118 protected: | |
| 119 virtual ~WebDialogDelegate() {} | |
| 120 }; | |
| 121 | |
| 122 | |
| 123 #endif // CHROME_BROWSER_UI_WEBUI_WEB_DIALOG_DELEGATE_H_ | |
| OLD | NEW |