[Toolbar] Base toolbar button class with background images for button states

chrome/browser/ui/views/toolbar/reload_button.cc

 // Copyright 2013 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.
 
 #include "chrome/browser/ui/views/toolbar/reload_button.h"
 
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/app/chrome_command_ids.h"
 #include "chrome/browser/command_updater.h"
 #include "chrome/browser/search/search.h"
 #include "chrome/browser/ui/search/search_model.h"
 #include "chrome/browser/ui/views/location_bar/location_bar_view.h"
 #include "grit/generated_resources.h"
 #include "grit/theme_resources.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/models/simple_menu_model.h"
 #include "ui/base/theme_provider.h"
 #include "ui/base/window_open_disposition.h"
 #include "ui/views/metrics.h"
 #include "ui/views/widget/widget.h"
 
 
 namespace {
 
-const int kReloadImages[] =
-    { IDR_RELOAD, IDR_RELOAD_H, IDR_RELOAD_P, IDR_RELOAD_D };
-
-const int kStopImages[] = { IDR_STOP, IDR_STOP_H, IDR_STOP_P, IDR_STOP_D };
-
 // Contents of the Reload drop-down menu.
 const int kReloadMenuItems[]  = {
   IDS_RELOAD_MENU_NORMAL_RELOAD_ITEM,
   IDS_RELOAD_MENU_HARD_RELOAD_ITEM,
   IDS_RELOAD_MENU_EMPTY_AND_HARD_RELOAD_ITEM,
 };
 
 }  // namespace
 
 
 // ReloadButton ---------------------------------------------------------------
 
 // static
 const char ReloadButton::kViewClassName[] = "ReloadButton";
 
 ReloadButton::ReloadButton(LocationBarView* location_bar,
                            CommandUpdater* command_updater)
-    : ButtonDropDown(this, CreateMenuModel()),
+    : ToolbarButton(this, CreateMenuModel()),
       location_bar_(location_bar),
       command_updater_(command_updater),
       intended_mode_(MODE_RELOAD),
       visible_mode_(MODE_RELOAD),
       double_click_timer_delay_(
           base::TimeDelta::FromMilliseconds(views::GetDoubleClickInterval())),
       stop_to_reload_timer_delay_(base::TimeDelta::FromMilliseconds(1350)),
       menu_enabled_(false),
       testing_mouse_hovered_(false),
       testing_reload_count_(0) {
 }
 
 ReloadButton::~ReloadButton() {
 }
 
 void ReloadButton::ChangeMode(Mode mode, bool force) {
   intended_mode_ = mode;
 
   // If the change is forced, or the user isn't hovering the icon, or it's safe
   // to change it to the other image type, make the change immediately;
   // otherwise we'll let it happen later.
   if (force || (!IsMouseHovered() && !testing_mouse_hovered_) ||
       ((mode == MODE_STOP) ?
       !double_click_timer_.IsRunning() : (visible_mode_ != MODE_STOP))) {
     double_click_timer_.Stop();
     stop_to_reload_timer_.Stop();
-    ChangeModeInternal(mode);
+    if (mode != visible_mode_)
+      ChangeModeInternal(mode);
     SetEnabled(true);
 
   // We want to disable the button if we're preventing a change from stop to
   // reload due to hovering, but not if we're preventing a change from reload to
   // stop due to the double-click timer running.  (Disabled reload state is only
   // applicable when instant extended API is enabled and mode is NTP, which is
   // handled just above.)
   } else if (visible_mode_ != MODE_RELOAD) {
     SetEnabled(false);
 
     // Go ahead and change to reload after a bit, which allows repeated reloads
     // without moving the mouse.
     if (!stop_to_reload_timer_.IsRunning()) {
       stop_to_reload_timer_.Start(FROM_HERE, stop_to_reload_timer_delay_, this,
                                   &ReloadButton::OnStopToReloadTimer);
     }
   }
 }
 
 void ReloadButton::LoadImages() {
-  DCHECK_EQ(static_cast<int>(arraysize(kReloadImages)), STATE_COUNT);
-  DCHECK_EQ(static_cast<int>(arraysize(kStopImages)), STATE_COUNT);
-
-  gfx::ImageSkia* reload_images = images_;
-  gfx::ImageSkia* stop_images = alternate_images_;
-  if (visible_mode_ == MODE_STOP)
-    std::swap(reload_images, stop_images);
-
-  ui::ThemeProvider* tp = GetThemeProvider();
-  for (int i = 0; i < STATE_COUNT; i++) {
-    reload_images[i] = *(tp->GetImageSkiaNamed(kReloadImages[i]));
-    stop_images[i] = *(tp->GetImageSkiaNamed(kStopImages[i]));
-  }
+  ChangeModeInternal(visible_mode_);
 
   SchedulePaint();
   PreferredSizeChanged();
 }
 
 void ReloadButton::OnMouseExited(const ui::MouseEvent& event) {
-  ButtonDropDown::OnMouseExited(event);
+  ToolbarButton::OnMouseExited(event);
   if (!IsMenuShowing())
     ChangeMode(intended_mode_, true);
 }
 
 bool ReloadButton::GetTooltipText(const gfx::Point& p,
                                   string16* tooltip) const {
   int reload_tooltip = menu_enabled_ ?
       IDS_TOOLTIP_RELOAD_WITH_MENU : IDS_TOOLTIP_RELOAD;
   int text_id = (visible_mode_ == MODE_RELOAD) ?
       reload_tooltip : IDS_TOOLTIP_STOP;
   tooltip->assign(l10n_util::GetStringUTF16(text_id));
   return true;
 }
 
 const char* ReloadButton::GetClassName() const {
   return kViewClassName;
 }
 
 void ReloadButton::GetAccessibleState(ui::AccessibleViewState* state) {
   if (menu_enabled_)
-    ButtonDropDown::GetAccessibleState(state);
+    ToolbarButton::GetAccessibleState(state);
   else
     CustomButton::GetAccessibleState(state);
 }
 
 bool ReloadButton::ShouldShowMenu() {
   return menu_enabled_ && (visible_mode_ == MODE_RELOAD);
 }
 
 void ReloadButton::ShowDropDownMenu(ui::MenuSourceType source_type) {
-  ButtonDropDown::ShowDropDownMenu(source_type);  // Blocks.
+  ToolbarButton::ShowDropDownMenu(source_type);  // Blocks.
   ChangeMode(intended_mode_, true);
 }
 
 void ReloadButton::ButtonPressed(views::Button* /* button */,
                                  const ui::Event& event) {
   ClearPendingMenu();
 
   if (visible_mode_ == MODE_STOP) {
     if (command_updater_)
       command_updater_->ExecuteCommandWithDisposition(IDC_STOP, CURRENT_TAB);
@@ skipping 86 matching lines @@
   if ((disposition == CURRENT_TAB) && location_bar_) {
     // Forcibly reset the location bar, since otherwise it won't discard any
     // ongoing user edits, since it doesn't realize this is a user-initiated
     // action.
     location_bar_->Revert();
   }
   command_updater_->ExecuteCommandWithDisposition(command, disposition);
 }
 
 void ReloadButton::ChangeModeInternal(Mode mode) {
-  if (visible_mode_ == mode)
-    return;
+  ui::ThemeProvider* tp = GetThemeProvider();
+  // Needed for unit tests.

[Peter Kasting, 2013/11/26 22:24:31]

Nit: Does this mean "|tp| can be NULL in unit tests."?  If so, I'd phrase it
that way.

[Greg Billock, 2013/11/27 14:22:35]

Done.

+  if (tp) {
+    SetImage(views::Button::STATE_NORMAL, *(tp->GetImageSkiaNamed(
+        (mode == MODE_RELOAD) ? IDR_RELOAD : IDR_STOP)));
+    SetImage(views::Button::STATE_DISABLED, *(tp->GetImageSkiaNamed(
+        (mode == MODE_RELOAD) ? IDR_RELOAD_D : IDR_STOP_D)));
+  }
 
-  for (size_t i = 0; i < STATE_COUNT; ++i)
-    std::swap(images_[i], alternate_images_[i]);
   visible_mode_ = mode;
   SchedulePaint();
 }
 
 void ReloadButton::OnDoubleClickTimer() {
   if (!IsMenuShowing())
     ChangeMode(intended_mode_, false);
 }
 
 void ReloadButton::OnStopToReloadTimer() {
   DCHECK(!IsMenuShowing());
   ChangeMode(intended_mode_, true);
 }