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

chrome/browser/ui/views/toolbar/toolbar_button.h

-// Copyright (c) 2012 The Chromium Authors. All rights reserved.
+// Copyright 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.
 
-#ifndef UI_VIEWS_CONTROLS_BUTTON_BUTTON_DROPDOWN_H_
-#define UI_VIEWS_CONTROLS_BUTTON_BUTTON_DROPDOWN_H_
+#ifndef CHROME_BROWSER_UI_VIEWS_TOOLBAR_TOOLBAR_BUTTON_H_
+#define CHROME_BROWSER_UI_VIEWS_TOOLBAR_TOOLBAR_BUTTON_H_
 
-#include "base/memory/weak_ptr.h"
+#include "ui/views/controls/button/label_button.h"
 #include "ui/views/context_menu_controller.h"
-#include "ui/views/controls/button/image_button.h"
+#include "ui/views/controls/button/button.h"
 
 namespace ui {
 class MenuModel;
 }
 
 namespace views {
+class MenuRunner;
+}
 
-class MenuRunner;
+// This class provides basic drawing and mouse-over behavior for buttons
+// appearing in the toolbar.
+// See ButtonDropDown.

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

ButtonDropDown no longer exists, AFAICT.

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

ui/views/controls/button/button_dropdown.h still exists, but as I put, I'm
suspicious that we may want to just basically move it here to the toolbar, as it
has no other users. What do you think? Is it a useful piece of generic kit? Or
should we just move/rename it as here? I could delete
ui/views/controls/button/button_dropdown.h as part of this change, or tear off
the move as a refactor assuming the initial toolbar/ move CL ever makes it
through the cq....

[Peter Kasting, 2013/11/15 22:11:56]

My guiding principle is "scope things narrowly", so I would move rather than
copying this.

+class ToolbarButton : public views::LabelButton,

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

Would we also make the "wrench" button (as it's still called in the code) be an
instance of this?  It seems on the surface like a good move.

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

Yes. I only did the one here to make sure we have the same plan, but if this is
the right direction let's do them all. I might keep just Reload in this cl to
make it a bit more digestible, though. I need to take out the site chip stuff,
too.

Mainly the current state is a WIP to make sure we have the same design in mind
and that it seems like it'll work.

[Peter Kasting, 2013/11/15 22:11:56]

K.  Either way is OK, whatever ends up being simpler.

+                      public views::ButtonListener,
+                      public views::ContextMenuController {
+ public:
+  // Takes ownership of the |model|, which can be null if no menu
+  // is to be shown.
+  ToolbarButton(ui::MenuModel* model);
+  virtual ~ToolbarButton();
 
-////////////////////////////////////////////////////////////////////////////////
-//
-// ButtonDropDown
-//
-// A button class that when pressed (and held) or pressed (and drag down) will
-// display a menu
-//
-////////////////////////////////////////////////////////////////////////////////
-class VIEWS_EXPORT ButtonDropDown : public ImageButton,
-                                    public ContextMenuController {
- public:
-  // The button's class name.
-  static const char kViewClassName[];
+  // Set up basic behavior. Should be called by any subclasses.
+  void Init();
 
-  // Takes ownership of the |model|.
-  ButtonDropDown(ButtonListener* listener, ui::MenuModel* model);
-  virtual ~ButtonDropDown();
+  // views::ButtonListener. Default implementation does nothing.
+  virtual void ButtonPressed(views::Button* sender,
+                             const ui::Event& event) OVERRIDE;
 
-  // If menu is currently pending for long press - stop it.
+  // Methods for handling ButtonDropDown-style menus.
   void ClearPendingMenu();
-
-  // Indicates if menu is currently showing.
   bool IsMenuShowing() const;
 
   // Overridden from views::View
   virtual bool OnMousePressed(const ui::MouseEvent& event) OVERRIDE;
   virtual bool OnMouseDragged(const ui::MouseEvent& event) OVERRIDE;
   virtual void OnMouseReleased(const ui::MouseEvent& event) OVERRIDE;
-  virtual const char* GetClassName() const OVERRIDE;
   // Showing the drop down results in a MouseCaptureLost, we need to ignore it.
   virtual void OnMouseCaptureLost() OVERRIDE {}
   virtual void OnMouseExited(const ui::MouseEvent& event) OVERRIDE;
   virtual void OnGestureEvent(ui::GestureEvent* event) OVERRIDE;
   virtual void GetAccessibleState(ui::AccessibleViewState* state) OVERRIDE;
 
   // Overridden from views::ContextMenuController
   virtual void ShowContextMenuForView(View* source,
                                       const gfx::Point& point,
                                       ui::MenuSourceType source_type) OVERRIDE;
@@ skipping 15 matching lines @@
   // The model that populates the attached menu.
   scoped_ptr<ui::MenuModel> model_;
 
   // Indicates if menu is currently showing.
   bool menu_showing_;
 
   // Y position of mouse when left mouse button is pressed
   int y_position_on_lbuttondown_;
 
   // Menu runner to display drop down menu.
-  scoped_ptr<MenuRunner> menu_runner_;
+  scoped_ptr<views::MenuRunner> menu_runner_;
 
   // A factory for tasks that show the dropdown context menu for the button.
-  base::WeakPtrFactory<ButtonDropDown> show_menu_factory_;
+  base::WeakPtrFactory<ToolbarButton> show_menu_factory_;
 
-  DISALLOW_COPY_AND_ASSIGN(ButtonDropDown);
+  DISALLOW_COPY_AND_ASSIGN(ToolbarButton);
 };
 
-}  // namespace views
-
-#endif  // UI_VIEWS_CONTROLS_BUTTON_BUTTON_DROPDOWN_H_
+#endif  // CHROME_BROWSER_UI_VIEWS_TOOLBAR_TOOLBAR_BUTTON_H_