[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 CHROME_BROWSER_UI_VIEWS_TOOLBAR_BUTTON_DROPDOWN_H_
-#define CHROME_BROWSER_UI_VIEWS_TOOLBAR_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/context_menu_controller.h"
-#include "ui/views/controls/button/image_button.h"
+#include "ui/views/controls/button/button.h"
+#include "ui/views/controls/button/label_button.h"
 
 namespace ui {
 class MenuModel;
 }
 
 namespace views {
 class MenuRunner;
 }
 
-////////////////////////////////////////////////////////////////////////////////
-//
-// ButtonDropDown
-//
-// A button class that when pressed (and held) or pressed (and drag down) will
-// display a menu
-//
-////////////////////////////////////////////////////////////////////////////////
-class ButtonDropDown : public views::ImageButton,
-                       public views::ContextMenuController {
+// This class provides basic drawing and mouse-over behavior for buttons
+// appearing in the toolbar.
+class ToolbarButton : public views::LabelButton,
+                      public views::ContextMenuController {
  public:
-  // The button's class name.
-  static const char kViewClassName[];
+  // Takes ownership of the |model|, which can be null if no menu
+  // is to be shown.
+  ToolbarButton(views::ButtonListener* listener, ui::MenuModel* model);
+  virtual ~ToolbarButton();
 
-  // Takes ownership of the |model|.
-  ButtonDropDown(views::ButtonListener* listener, ui::MenuModel* model);
-  virtual ~ButtonDropDown();
+  // Set up basic mouseover border behavior.
+  // Should be called before first paint.
+  void Init();
 
-  // 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
+  // views::LabelButton:
+  virtual gfx::Size GetPreferredSize();
   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 OnMouseCaptureLost() OVERRIDE;
   virtual void OnMouseExited(const ui::MouseEvent& event) OVERRIDE;
   virtual void OnGestureEvent(ui::GestureEvent* event) OVERRIDE;
   virtual void GetAccessibleState(ui::AccessibleViewState* state) OVERRIDE;
+  virtual gfx::Rect GetThemePaintRect() const OVERRIDE;

[Peter Kasting, 2013/11/23 00:23:55]

Because only the back button needs this override, SetLeftMargin(), and
|margin_left_|, it seems like maybe we should add a simple BackButton subclass
of ToolbarButton that just defines these.

This will also let us write more specific comments on these methods about what
the back button does, instead of the somewhat vague wording on |margin_left_|
right now.

[Greg Billock, 2013/11/25 17:16:30]

Makes sense. Looking at the wrench menu, it wants the same thing, but the other
side, so that'll fit into that subclass.

[Peter Kasting, 2013/11/26 02:25:46]

Is your intent to do this in a separate change, then?

[Greg Billock, 2013/11/26 16:58:32]

Yeah I'd like to check this in so the site chip class can land. I'll factor the
back button out next thing.

 
-  // Overridden from views::ContextMenuController
-  virtual void ShowContextMenuForView(views::View* source,
+  // views::ContextMenuController:
+  virtual void ShowContextMenuForView(View* source,
                                       const gfx::Point& point,
                                       ui::MenuSourceType source_type) OVERRIDE;
 
+  void SetLeftMargin(int margin);
+
  protected:
   // Overridden from CustomButton. Returns true if the button should become
   // pressed when a user holds the mouse down over the button. For this
   // implementation, both left and right mouse buttons can trigger a change
   // to the PUSHED state.
   virtual bool ShouldEnterPushedState(const ui::Event& event) OVERRIDE;
 
   // Returns if menu should be shown. Override this to change default behavior.
   virtual bool ShouldShowMenu();
 
   // Function to show the dropdown menu.
   virtual void ShowDropDownMenu(ui::MenuSourceType source_type);
 
  private:
   // 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_;
 
+  // Any leading margin to be applied. Used when toolbar buttons are in
+  // a maximized state to extend to the full window width.
+  int margin_left_;
+
   // Menu runner to display drop down menu.
   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);
 };
 
-#endif  // CHROME_BROWSER_UI_VIEWS_TOOLBAR_BUTTON_DROPDOWN_H_
+#endif  // CHROME_BROWSER_UI_VIEWS_TOOLBAR_TOOLBAR_BUTTON_H_