Home | History | Annotate | Download | only in browser 
      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 CONTENT_PUBLIC_BROWSER_JAVASCRIPT_DIALOG_MANAGER_H_
      6 #define CONTENT_PUBLIC_BROWSER_JAVASCRIPT_DIALOG_MANAGER_H_
      7 
      8 #include <string>
      9 
     10 #include "base/callback.h"
     11 #include "base/strings/string16.h"
     12 #include "content/common/content_export.h"
     13 #include "content/public/common/javascript_message_type.h"
     14 #include "ui/gfx/native_widget_types.h"
     15 #include "url/gurl.h"
     16 
     17 namespace content {
     18 
     19 class WebContents;
     20 
     21 // An interface consisting of methods that can be called to produce and manage
     22 // JavaScript dialogs.
     23 class CONTENT_EXPORT JavaScriptDialogManager {
     24  public:
     25   typedef base::Callback<void(bool /* success */,
     26                               const base::string16& /* user_input */)>
     27                                   DialogClosedCallback;
     28 
     29   // Displays a JavaScript dialog. |did_suppress_message| will not be nil; if
     30   // |true| is returned in it, the caller will handle faking the reply.
     31   virtual void RunJavaScriptDialog(
     32       WebContents* web_contents,
     33       const GURL& origin_url,
     34       const std::string& accept_lang,
     35       JavaScriptMessageType javascript_message_type,
     36       const base::string16& message_text,
     37       const base::string16& default_prompt_text,
     38       const DialogClosedCallback& callback,
     39       bool* did_suppress_message) = 0;
     40 
     41   // Displays a dialog asking the user if they want to leave a page.
     42   virtual void RunBeforeUnloadDialog(WebContents* web_contents,
     43                                      const base::string16& message_text,
     44                                      bool is_reload,
     45                                      const DialogClosedCallback& callback) = 0;
     46 
     47   // Accepts or dismisses the active JavaScript dialog, which must be owned
     48   // by the given |web_contents|. If |prompt_override| is not null, the prompt
     49   // text of the dialog should be set before accepting. Returns true if the
     50   // dialog was handled.
     51   virtual bool HandleJavaScriptDialog(WebContents* web_contents,
     52                                       bool accept,
     53                                       const base::string16* prompt_override);
     54 
     55   // Cancels all active and pending dialogs for the given WebContents.
     56   virtual void CancelActiveAndPendingDialogs(WebContents* web_contents) = 0;
     57 
     58   // The given WebContents is being destroyed; discards any saved state tied
     59   // to it.
     60   virtual void WebContentsDestroyed(WebContents* web_contents) = 0;
     61 
     62   virtual ~JavaScriptDialogManager() {}
     63 };
     64 
     65 }  // namespace content
     66 
     67 #endif  // CONTENT_PUBLIC_BROWSER_JAVASCRIPT_DIALOG_MANAGER_H_
     68