Dismiss action in tab modal dialogs.

chrome/browser/ui/tab_modal_confirm_dialog_delegate.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_BROWSER_UI_TAB_MODAL_CONFIRM_DIALOG_DELEGATE_H_
 #define CHROME_BROWSER_UI_TAB_MODAL_CONFIRM_DIALOG_DELEGATE_H_
 
 #include "base/callback.h"
 #include "base/compiler_specific.h"
 #include "base/strings/string16.h"
@@ skipping 24 matching lines @@
 // whether the user wants to execute a certain action.
 class TabModalConfirmDialogDelegate : public content::NotificationObserver {
  public:
   explicit TabModalConfirmDialogDelegate(content::WebContents* web_contents);
   virtual ~TabModalConfirmDialogDelegate();
 
   void set_close_delegate(TabModalConfirmDialogCloseDelegate* close_delegate) {
     close_delegate_ = close_delegate;
   }
 
-  // Accepts the confirmation prompt and calls |OnAccepted|.
+  // Accepts the confirmation prompt and calls |OnAccepted| if no other call
+  // to |Accept|, |Cancel|, |LinkClicked| or |Dismissed| has been made before.
   // This method is safe to call even from an |OnAccepted| or |OnCanceled|
   // callback.
-  void Accept();
+  // Returns true if |OnAccepted| has been called, false otherwise.
+  bool Accept();

[fdoray, 2013/06/28 15:32:59]

Changing the return value is helpful to avoid multiple calls to
DialogDelegate::OnClose (see DialogClientView::CanClose).

I think it's cleaner to avoid multiple calls to DialogDelegate::OnClose, but it
doesn't really change anything since the implementation of this method is always
empty for tab modal dialogs.

 
-  // Cancels the confirmation prompt and calls |OnCanceled|.
+  // Cancels the confirmation prompt and calls |OnCanceled| if no other call
+  // to |Accept|, |Cancel|, |LinkClicked| or |Dismissed| has been made before.
   // This method is safe to call even from an |OnAccepted| or |OnCanceled|
   // callback.
-  void Cancel();
+  // Returns true if |OnCanceled| has been called, false otherwise.
+  bool Cancel();
 
   // Called when the link (if any) is clicked. Calls |OnLinkClicked| and closes
-  // the dialog. The |disposition| specifies how the resulting document should
-  // be loaded (based on the event flags present when the link was clicked).
-  void LinkClicked(WindowOpenDisposition disposition);
+  // the dialog if no other call to |Accept|, |Cancel|, |LinkClicked| or
+  // |Dismissed| has been made before. The |disposition| specifies how the
+  // resulting document should be loaded (based on the event flags present when
+  // the link was clicked).
+  // Returns true if |OnLinkClicked| has been called, false otherwise.
+  bool LinkClicked(WindowOpenDisposition disposition);
+
+  // Called when the dialog is dismissed (by clicking on the Close button,
+  // closing the parent tab or navigating to another page in the parent tab).
+  // Calls |OnDismissed| and closes the dialog if no other call to |Accept|,
+  // |Cancel|, |LinkClicked| or |Dismissed| has been made before.
+  // Returns true if |OnDismissed| has been called, false otherwise.
+  bool Dismissed();
 
   // The title of the dialog. Note that the title is not shown on all platforms.
   virtual string16 GetTitle() = 0;
   virtual string16 GetMessage() = 0;
 
   // Icon to show for the dialog. If this method is not overridden, a default
   // icon (like the application icon) is shown.
   virtual gfx::Image* GetIcon();
 
   // Title for the accept and the cancel buttons.
@@ skipping 18 matching lines @@
 
   // content::NotificationObserver implementation.
   // Watch for a new load or a closed tab and dismiss the dialog if they occur.
   virtual void Observe(int type,
                        const content::NotificationSource& source,
                        const content::NotificationDetails& details) OVERRIDE;
 
   content::NotificationRegistrar registrar_;
 
  private:
-  // It is guaranteed that exactly one of |OnAccepted|, |OnCanceled| or
-  // |OnLinkClicked| is eventually called. These method are private to
-  // enforce this guarantee. Access to them is controlled by |Accept|,
-  // |Cancel| and |LinkClicked|.
+  // It is guaranteed that exactly one of the |On...| methods is eventually
+  // called. These method are private to enforce this guarantee. Access to them
+  // is  controlled by |Accept|, |Cancel|, |LinkClicked| and |Dismissed|.
 
   // Called when the user accepts or cancels the dialog, respectively.
   virtual void OnAccepted();
   virtual void OnCanceled();
 
   // Called when the user clicks on the link (if any).
   virtual void OnLinkClicked(WindowOpenDisposition disposition);
 
+  // Called when the dialog is dismissed.
+  virtual void OnDismissed();
+
   // Close the dialog.
   void CloseDialog();
 
   TabModalConfirmDialogCloseDelegate* close_delegate_;
   // True iff we are in the process of closing, to avoid running callbacks
   // multiple times.
   bool closing_;
 
   DISALLOW_COPY_AND_ASSIGN(TabModalConfirmDialogDelegate);
 };
 
 #endif  // CHROME_BROWSER_UI_TAB_MODAL_CONFIRM_DIALOG_DELEGATE_H_