ui/views/window/dialog_client_view.h

   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 UI_VIEWS_WINDOW_DIALOG_CLIENT_VIEW_H_
   6 #define UI_VIEWS_WINDOW_DIALOG_CLIENT_VIEW_H_
   7
   8 #include "ui/base/ui_base_types.h"
   9 #include "ui/views/controls/button/button.h"
  10 #include "ui/views/focus/focus_manager.h"
  11 #include "ui/views/window/client_view.h"
  12
  13 namespace views {
  14
  15 class DialogDelegate;
  16 class LabelButton;
  17 class Widget;
  18
  19 // DialogClientView provides adornments for a dialog's content view, including
  20 // custom-labeled [OK] and [Cancel] buttons with [Enter] and [Esc] accelerators.
  21 // The view also displays the delegate's extra view alongside the buttons and
  22 // the delegate's footnote view below the buttons. The view appears like below.
  23 // NOTE: The contents view is not inset on the top or side client view edges.
  24 //   +------------------------------+
  25 //   |        Contents View         |
  26 //   +------------------------------+
  27 //   | [Extra View]   [OK] [Cancel] |
  28 //   | [      Footnote View       ] |
  29 //   +------------------------------+
  30 class VIEWS_EXPORT DialogClientView : public ClientView,
  31                                       public ButtonListener,
  32                                       public FocusChangeListener {
  33  public:
  34   DialogClientView(Widget* widget, View* contents_view);
  35   ~DialogClientView() override;
  36
  37   // Accept or Cancel the dialog.
  38   void AcceptWindow();
  39   void CancelWindow();
  40
  41   // Accessors in case the user wishes to adjust these buttons.
  42   LabelButton* ok_button() const { return ok_button_; }
  43   LabelButton* cancel_button() const { return cancel_button_; }
  44
  45   // Update the dialog buttons to match the dialog's delegate.
  46   void UpdateDialogButtons();
  47
  48   // ClientView implementation:
  49   bool CanClose() override;
  50   DialogClientView* AsDialogClientView() override;
  51   const DialogClientView* AsDialogClientView() const override;
  52
  53   // FocusChangeListener implementation:
  54   void OnWillChangeFocus(View* focused_before, View* focused_now) override;
  55   void OnDidChangeFocus(View* focused_before, View* focused_now) override;
  56
  57   // View implementation:
  58   gfx::Size GetPreferredSize() const override;
  59   void Layout() override;
  60   bool AcceleratorPressed(const ui::Accelerator& accelerator) override;
  61   void ViewHierarchyChanged(
  62       const ViewHierarchyChangedDetails& details) override;
  63   void NativeViewHierarchyChanged() override;
  64   void OnNativeThemeChanged(const ui::NativeTheme* theme) override;
  65
  66   // ButtonListener implementation:
  67   void ButtonPressed(Button* sender, const ui::Event& event) override;
  68
  69  protected:
  70   // For testing.
  71   DialogClientView(View* contents_view);
  72
  73   // Returns the DialogDelegate for the window. Virtual for testing.
  74   virtual DialogDelegate* GetDialogDelegate() const;
  75
  76   // Create and add the extra view, if supplied by the delegate.
  77   void CreateExtraView();
  78
  79   // Creates and adds the footnote view, if supplied by the delegate.
  80   void CreateFootnoteView();
  81
  82   // View implementation.
  83   void ChildPreferredSizeChanged(View* child) override;
  84   void ChildVisibilityChanged(View* child) override;
  85
  86  private:
  87   FRIEND_TEST_ALL_PREFIXES(DialogClientViewTest, FocusManager);
  88
  89   bool has_dialog_buttons() const { return ok_button_ || cancel_button_; }
  90
  91   // Create a dialog button of the appropriate type.
  92   LabelButton* CreateDialogButton(ui::DialogButton type);
  93
  94   // Update |button|'s text and enabled state according to the delegate's state.
  95   void UpdateButton(LabelButton* button, ui::DialogButton type);
  96
  97   // Returns the height of the row containing the buttons and the extra view.
  98   int GetButtonsAndExtraViewRowHeight() const;
  99
 100   // Returns the insets for the buttons and extra view.
 101   gfx::Insets GetButtonRowInsets() const;
 102
 103   // Closes the widget.
 104   void Close();
 105
 106   // The dialog buttons.
 107   LabelButton* ok_button_;
 108   LabelButton* cancel_button_;
 109
 110   // The button that is currently default; may be NULL.
 111   LabelButton* default_button_;
 112
 113   // Observe |focus_manager_| to update the default button with focus changes.
 114   FocusManager* focus_manager_;
 115
 116   // The extra view shown in the row of buttons; may be NULL.
 117   View* extra_view_;
 118
 119   // The footnote view shown below the buttons; may be NULL.
 120   View* footnote_view_;
 121
 122   // True if we've notified the delegate the window is closing and the delegate
 123   // allosed the close. In some situations it's possible to get two closes (see
 124   // http://crbug.com/71940). This is used to avoid notifying the delegate
 125   // twice, which can have bad consequences.
 126   bool notified_delegate_;
 127
 128   DISALLOW_COPY_AND_ASSIGN(DialogClientView);
 129 };
 130
 131 }  // namespace views
 132
 133 #endif  // UI_VIEWS_WINDOW_DIALOG_CLIENT_VIEW_H_