src/chrome/browser/ui/views/translate/translate_bubble_view.h

   1 // Copyright 2013 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_VIEWS_TRANSLATE_TRANSLATE_BUBBLE_VIEW_H_
   6 #define CHROME_BROWSER_UI_VIEWS_TRANSLATE_TRANSLATE_BUBBLE_VIEW_H_
   7
   8 #include <map>
   9 #include <string>
  10
  11 #include "base/basictypes.h"
  12 #include "chrome/browser/translate/chrome_translate_client.h"
  13 #include "chrome/browser/ui/translate/language_combobox_model.h"
  14 #include "chrome/browser/ui/translate/translate_bubble_model.h"
  15 #include "components/translate/core/common/translate_errors.h"
  16 #include "content/public/browser/web_contents_observer.h"
  17 #include "ui/views/bubble/bubble_delegate.h"
  18 #include "ui/views/controls/button/button.h"
  19 #include "ui/views/controls/combobox/combobox_listener.h"
  20 #include "ui/views/controls/link_listener.h"
  21
  22 class PrefService;
  23
  24 namespace views {
  25 class Checkbox;
  26 class GridLayout;
  27 class LabelButton;
  28 class Link;
  29 class View;
  30 }
  31
  32 namespace ui {
  33 class SimpleComboboxModel;
  34 }
  35
  36 class TranslateBubbleView : public views::BubbleDelegateView,
  37                             public views::ButtonListener,
  38                             public views::ComboboxListener,
  39                             public views::LinkListener,
  40                             public content::WebContentsObserver {
  41  public:
  42   ~TranslateBubbleView() override;
  43
  44   // Shows the Translate bubble.
  45   //
  46   // |is_user_gesture| is true when the bubble is shown on the user's delibarate
  47   // action.
  48   static void ShowBubble(views::View* anchor_view,
  49                          content::WebContents* web_contents,
  50                          translate::TranslateStep step,
  51                          translate::TranslateErrors::Type error_type,
  52                          bool is_user_gesture);
  53
  54   // Closes the current bubble if existing.
  55   static void CloseBubble();
  56
  57   // If true, the Translate bubble is being shown.
  58   static bool IsShowing();
  59
  60   // Returns the bubble view currently shown. This may return NULL.
  61   static TranslateBubbleView* GetCurrentBubble();
  62
  63   TranslateBubbleModel* model() { return model_.get(); }
  64
  65   // views::BubbleDelegateView methods.
  66   void Init() override;
  67   void ButtonPressed(views::Button* sender, const ui::Event& event) override;
  68
  69   // views::WidgetDelegate method.
  70   void WindowClosing() override;
  71
  72   // views::View methods.
  73   bool AcceleratorPressed(const ui::Accelerator& accelerator) override;
  74   gfx::Size GetPreferredSize() const override;
  75
  76   // views::CombboxListener methods.
  77   void OnPerformAction(views::Combobox* combobox) override;
  78
  79   // views::LinkListener method.
  80   void LinkClicked(views::Link* source, int event_flags) override;
  81
  82   // content::WebContentsObserver method.
  83   void WebContentsDestroyed() override;
  84
  85   // Returns the current view state.
  86   TranslateBubbleModel::ViewState GetViewState() const;
  87
  88  private:
  89   enum LinkID {
  90     LINK_ID_ADVANCED,
  91     LINK_ID_LANGUAGE_SETTINGS,
  92   };
  93
  94   enum ButtonID {
  95     BUTTON_ID_TRANSLATE,
  96     BUTTON_ID_DONE,
  97     BUTTON_ID_CANCEL,
  98     BUTTON_ID_SHOW_ORIGINAL,
  99     BUTTON_ID_TRY_AGAIN,
 100     BUTTON_ID_ALWAYS_TRANSLATE,
 101   };
 102
 103   enum ComboboxID {
 104     COMBOBOX_ID_DENIAL,
 105     COMBOBOX_ID_SOURCE_LANGUAGE,
 106     COMBOBOX_ID_TARGET_LANGUAGE,
 107   };
 108
 109   friend class TranslateBubbleViewTest;
 110   FRIEND_TEST_ALL_PREFIXES(TranslateBubbleViewTest, TranslateButton);
 111   FRIEND_TEST_ALL_PREFIXES(TranslateBubbleViewTest, AdvancedLink);
 112   FRIEND_TEST_ALL_PREFIXES(TranslateBubbleViewTest, ShowOriginalButton);
 113   FRIEND_TEST_ALL_PREFIXES(TranslateBubbleViewTest, TryAgainButton);
 114   FRIEND_TEST_ALL_PREFIXES(TranslateBubbleViewTest,
 115                            AlwaysTranslateCheckboxAndCancelButton);
 116   FRIEND_TEST_ALL_PREFIXES(TranslateBubbleViewTest,
 117                            AlwaysTranslateCheckboxAndDoneButton);
 118   FRIEND_TEST_ALL_PREFIXES(TranslateBubbleViewTest, DoneButton);
 119   FRIEND_TEST_ALL_PREFIXES(TranslateBubbleViewTest,
 120                            DoneButtonWithoutTranslating);
 121   FRIEND_TEST_ALL_PREFIXES(TranslateBubbleViewTest,
 122                            CancelButtonReturningBeforeTranslate);
 123   FRIEND_TEST_ALL_PREFIXES(TranslateBubbleViewTest,
 124                            CancelButtonReturningAfterTranslate);
 125   FRIEND_TEST_ALL_PREFIXES(TranslateBubbleViewTest, CancelButtonReturningError);
 126
 127   TranslateBubbleView(views::View* anchor_view,
 128                       scoped_ptr<TranslateBubbleModel> model,
 129                       translate::TranslateErrors::Type error_type,
 130                       content::WebContents* web_contents);
 131
 132   // Returns the current child view.
 133   views::View* GetCurrentView() const;
 134
 135   // Handles the event when the user presses a button.
 136   void HandleButtonPressed(ButtonID sender_id);
 137
 138   // Handles the event when the user clicks a link.
 139   void HandleLinkClicked(LinkID sender_id);
 140
 141   // Handles the event when the user changes an index of a combobox.
 142   void HandleComboboxPerformAction(ComboboxID sender_id);
 143
 144   // Updates the visibilities of child views according to the current view type.
 145   void UpdateChildVisibilities();
 146
 147   // Creates the 'before translate' view. Caller takes ownership of the returned
 148   // view.
 149   views::View* CreateViewBeforeTranslate();
 150
 151   // Creates the 'translating' view. Caller takes ownership of the returned
 152   // view.
 153   views::View* CreateViewTranslating();
 154
 155   // Creates the 'after translate' view. Caller takes ownership of the returned
 156   // view.
 157   views::View* CreateViewAfterTranslate();
 158
 159   // Creates the 'error' view. Caller takes ownership of the returned view.
 160   views::View* CreateViewError();
 161
 162   // Creates the 'advanced' view. Caller takes ownership of the returned view.
 163   views::View* CreateViewAdvanced();
 164
 165   // Switches the view type.
 166   void SwitchView(TranslateBubbleModel::ViewState view_state);
 167
 168   // Switches to the error view.
 169   void SwitchToErrorView(translate::TranslateErrors::Type error_type);
 170
 171   // Updates the advanced view.
 172   void UpdateAdvancedView();
 173
 174   static TranslateBubbleView* translate_bubble_view_;
 175
 176   views::View* before_translate_view_;
 177   views::View* translating_view_;
 178   views::View* after_translate_view_;
 179   views::View* error_view_;
 180   views::View* advanced_view_;
 181
 182   scoped_ptr<ui::SimpleComboboxModel> denial_combobox_model_;
 183   scoped_ptr<LanguageComboboxModel> source_language_combobox_model_;
 184   scoped_ptr<LanguageComboboxModel> target_language_combobox_model_;
 185
 186   views::Combobox* denial_combobox_;
 187   views::Combobox* source_language_combobox_;
 188   views::Combobox* target_language_combobox_;
 189
 190   views::Checkbox* always_translate_checkbox_;
 191
 192   views::LabelButton* advanced_cancel_button_;
 193   views::LabelButton* advanced_done_button_;
 194
 195   scoped_ptr<TranslateBubbleModel> model_;
 196
 197   translate::TranslateErrors::Type error_type_;
 198
 199   // Whether the window is an incognito window.
 200   const bool is_in_incognito_window_;
 201
 202   // Whether the translation is acutually executed.
 203   bool translate_executed_;
 204
 205   // Whether one of denial buttons is clicked.
 206   bool denial_button_clicked_;
 207
 208   DISALLOW_COPY_AND_ASSIGN(TranslateBubbleView);
 209 };
 210
 211 #endif  // CHROME_BROWSER_UI_VIEWS_TRANSLATE_TRANSLATE_BUBBLE_VIEW_H_