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