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

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

 // 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.
 
 #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 };
+    { IDR_RELOAD_INNER, IDR_RELOAD_INNER, IDR_RELOAD_INNER,
+      IDR_RELOAD_INNER_DIMMED };
 
-const int kStopImages[] = { IDR_STOP, IDR_STOP_H, IDR_STOP_P, IDR_STOP_D };
+const int kStopImages[] = { IDR_STOP_INNER, IDR_STOP_INNER, IDR_STOP_INNER,
+                            IDR_STOP_INNER_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(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() {
-}
+};
+

[Peter Kasting, 2013/11/15 03:28:58]

Nit: Extra semicolon and newline

[Greg Billock, 2013/11/15 19:36:50]

Done.

 
 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))) {
@@ skipping 31 matching lines @@
   for (int i = 0; i < STATE_COUNT; i++) {
     reload_images[i] = *(tp->GetImageSkiaNamed(kReloadImages[i]));
     stop_images[i] = *(tp->GetImageSkiaNamed(kStopImages[i]));
   }
 
   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 89 matching lines @@
     // action.
     location_bar_->Revert();
   }
   command_updater_->ExecuteCommandWithDisposition(command, disposition);
 }
 
 void ReloadButton::ChangeModeInternal(Mode mode) {
   if (visible_mode_ == mode)
     return;
 
-  for (size_t i = 0; i < STATE_COUNT; ++i)
+  for (size_t i = 0; i < STATE_COUNT; ++i) {
     std::swap(images_[i], alternate_images_[i]);

[Peter Kasting, 2013/11/15 03:28:58]

Nit: It seems like at the least we could name these arrays better
(|reload_images_| and |stop_images_|?) and avoid the swap() call.

I'd think we could do even better than this, but I can't actually figure out
from just staring at things how ReloadButton actually paints the selected image
set before your patch.

[Greg Billock, 2013/11/15 19:36:50]

It's in the guts of ButtonDropDown > ImageButton, and the existing use isn't
super-pretty -- there's a variable overload of a private superclass member. The
works. I agree this will improve with LabelButton.

+    SetImage((views::Button::ButtonState)i, images_[i]);

[Peter Kasting, 2013/11/15 03:28:58]

Nit: Don't use C-style casts

[Greg Billock, 2013/11/15 19:36:50]

Done.

+  }
+
   visible_mode_ = mode;
   SchedulePaint();
 }
 
 void ReloadButton::OnDoubleClickTimer() {
   if (!IsMenuShowing())
     ChangeMode(intended_mode_, false);
 }
 
 void ReloadButton::OnStopToReloadTimer() {
   DCHECK(!IsMenuShowing());
   ChangeMode(intended_mode_, true);
 }