Dismiss action in tab modal dialogs.

ui/views/window/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 UI_VIEWS_WINDOW_DIALOG_DELEGATE_H_
 #define UI_VIEWS_WINDOW_DIALOG_DELEGATE_H_
 
 #include "base/compiler_specific.h"
 #include "base/strings/string16.h"
 #include "ui/base/accessibility/accessibility_types.h"
@@ skipping 36 matching lines @@
   // Override this function to display an extra view in the titlebar.
   // Overrides may construct the view; this will only be called once per dialog.
   // Note: this only works for new style dialogs.
   virtual View* CreateTitlebarExtraView();
 
   // Override this function to display a footnote view below the buttons.
   // Overrides may construct the view; this will only be called once per dialog.
   virtual View* CreateFootnoteView();
 
   // For Dialog boxes, if there is a "Cancel" button or no dialog button at all,
-  // this is called when the user presses the "Cancel" button or the Close
-  // button on the window or in the system menu, or presses the Esc key.
-  // This function should return true if the window can be closed after it
-  // returns, or false if it must remain open.
+  // this is called when the user presses the "Cancel" button or the Esc key.
+  // It can also be called on a dismiss action if |Dismiss| has not been
+  // overridden. This function should return true if the window can be closed
+  // after it returns, or false if it must remain open.
   virtual bool Cancel();
 
   // For Dialog boxes, this is called when the user presses the "OK" button,
-  // or the Enter key.  Can also be called on Esc key or close button
-  // presses if there is no "Cancel" button.  This function should return
-  // true if the window can be closed after it returns, or false if it must
-  // remain open.  If |window_closing| is true, it means that this handler is
+  // or the Enter key. It can also be called on a dismiss action if |Dismiss|
+  // has not been overridden. This function should return true if the window
+  // can be closed after it returns, or false if it must remain open.
+  // If |window_closing| is true, it means that this handler is
   // being called because the window is being closed (e.g.  by Window::Close)
   // and there is no Cancel handler, so Accept is being called instead.
   virtual bool Accept(bool window_closing);
   virtual bool Accept();
 
+  // For Dialog boxes, this is called when the user presses the Close button
+  // on the window or in the system menu. The default behavior is to call
+  // |Cancel| if the dialog has a "Cancel" button or no button at all, or
+  // |Accept| otherwise. This function should return true if the window can be
+  // closed after it returns, or false if it must remain open.
+  virtual bool Dismiss();

[Ben Goodger (Google), 2013/07/23 17:52:09]

Can we call this "Close()"? That is more in keeping with platform conventions
(e.g. WM_CLOSE). I would then rephrase this comment to:

// Called when the user closes the window without selecting an option, e.g. by
pressing the close button on the window or using a window manager gesture. By
default this calls the Cancel() function.

[fdoray, 2013/07/24 15:09:16]

Yes... but there is a |OnClose| method in DialogDelegate that is called for
every action (Accept, Cancel, Dismiss). Will that be confusing?

Also, some subclasses have a |Close| method that actually closes the dialog
(ExtensionDialog, BookmarkEditorView). Here, Dismiss doesn't actually close the
dialog: it just returns a boolean (and do some extra stuff when it's
overridden).

Can I call the method |Closed|?

On 2013/07/23 17:52:09, Ben Goodger (Google) wrote:

[Ben Goodger (Google), 2013/07/24 17:56:21]

I'd change the notification below to OnClosed() (past tense, to match its
behavior) and change this to Close() (verb).

Bigger picture, there should probably be a WidgetObserver method that tracks
widget closing that people observer, rather than having a
DialogDelegate-specific method.

[fdoray, 2013/07/24 20:21:07]

Done.

Little concern about using a verb: as I said in my last comment, this doesn't
close the dialog. It's called from DialogClientView::CanClose, when the widget
is already trying to close itself.

On 2013/07/24 17:56:21, Ben Goodger (Google) wrote:

+
   // Overridden from ui::DialogModel:
   virtual base::string16 GetDialogLabel() const OVERRIDE;
   virtual base::string16 GetDialogTitle() const OVERRIDE;
   virtual int GetDialogButtons() const OVERRIDE;
   virtual int GetDefaultDialogButton() const OVERRIDE;
   virtual base::string16 GetDialogButtonLabel(
       ui::DialogButton button) const OVERRIDE;
   virtual bool IsDialogButtonEnabled(ui::DialogButton button) const OVERRIDE;
   virtual bool OnDialogButtonActivated(ui::DialogButton button) OVERRIDE;
 
@@ skipping 46 matching lines @@
   virtual const Widget* GetWidget() const OVERRIDE;
   virtual View* GetContentsView() OVERRIDE;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(DialogDelegateView);
 };
 
 }  // namespace views
 
 #endif  // UI_VIEWS_WINDOW_DIALOG_DELEGATE_H_