Refactoring to make adding ink drop animations easier

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

 // 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.
 
 #ifndef CHROME_BROWSER_UI_VIEWS_TOOLBAR_TOOLBAR_ACTION_VIEW_H_
 #define CHROME_BROWSER_UI_VIEWS_TOOLBAR_TOOLBAR_ACTION_VIEW_H_
 
 #include "chrome/browser/ui/views/toolbar/toolbar_action_view_delegate_views.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
+#include "ui/views/animation/ink_drop_host.h"
 #include "ui/views/context_menu_controller.h"
 #include "ui/views/controls/button/menu_button.h"
 #include "ui/views/controls/button/menu_button_listener.h"
 #include "ui/views/drag_controller.h"
 #include "ui/views/view.h"
 
 class ExtensionAction;
 class Profile;
 
 namespace extensions {
 class Extension;
 }
 
 namespace gfx {
 class Image;
 }
 
 namespace views {
+class InkDropAnimationController;
 class MenuRunner;
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // ToolbarActionView
 // A wrapper around a ToolbarActionViewController to display a toolbar action
 // action in the BrowserActionsContainer.
 class ToolbarActionView : public views::MenuButton,
                           public ToolbarActionViewDelegateViews,
                           public views::MenuButtonListener,
                           public views::ContextMenuController,
-                          public content::NotificationObserver {
+                          public content::NotificationObserver,
+                          public views::InkDropHost {
  public:
   // Need DragController here because ToolbarActionView could be
   // dragged/dropped.
   class Delegate : public views::DragController {
    public:
     // Returns the current web contents.
     virtual content::WebContents* GetCurrentWebContents() = 0;
 
     // Whether the container for this button is shown inside a menu.
     virtual bool ShownInsideMenu() const = 0;
@@ skipping 16 matching lines @@
                     Profile* profile,
                     Delegate* delegate);
   ~ToolbarActionView() override;
 
   // views::MenuButton:
   void GetAccessibleState(ui::AXViewState* state) override;
 
   // views::MenuButtonListener:
   void OnMenuButtonClicked(views::View* sender,
                            const gfx::Point& point) override;
+  void OnMenuButtonClickCanceled(views::View* sender) override;
 
   // content::NotificationObserver:
   void Observe(int type,
                const content::NotificationSource& source,
                const content::NotificationDetails& details) override;
 
   // views::MenuButton:
   scoped_ptr<views::LabelButtonBorder> CreateDefaultBorder() const override;
   void OnMouseEntered(const ui::MouseEvent& event) override;
   bool ShouldEnterPushedState(const ui::Event& event) override;
 
   // ToolbarActionViewDelegate: (public because called by others).
   void UpdateState() override;
   content::WebContents* GetCurrentWebContents() const override;
 
   ToolbarActionViewController* view_controller() {
     return view_controller_;
   }
 
   // Returns button icon so it can be accessed during tests.
   gfx::ImageSkia GetIconForTest();
 
   bool wants_to_run_for_testing() const { return wants_to_run_; }
 
+  // views::InkDropHost:
+  void AddInkDropLayer(ui::Layer* ink_drop_layer) override;
+  void RemoveInkDropLayer(ui::Layer* ink_drop_layer) override;
+
+ protected:
+  // Returns the Point where the ink drop should be centered.
+  virtual gfx::Point CalculateInkDropCenter() const;
+
+  views::InkDropAnimationController* ink_drop_animation_controller() {
+    return ink_drop_animation_controller_.get();
+  }
+
+  views::InkDropDelegate* GetInkDropDelegate() const override;
+
  private:
   // views::MenuButton:
   gfx::Size GetPreferredSize() const override;
+  void Layout() override;
+  bool OnMousePressed(const ui::MouseEvent& event) override;
+  void OnGestureEvent(ui::GestureEvent* event) override;
   void OnDragDone() override;
   void ViewHierarchyChanged(
       const ViewHierarchyChangedDetails& details) override;
 
   // ToolbarActionViewDelegateViews:
   views::View* GetAsView() override;
   views::FocusManager* GetFocusManagerForAccelerator() override;
   views::View* GetReferenceViewForPopup() override;
   bool IsMenuRunning() const override;
   void OnPopupShown(bool by_user) override;
@@ skipping 25 matching lines @@
   // Delegate that usually represents a container for ToolbarActionView.
   Delegate* delegate_;
 
   // Used to make sure we only register the command once.
   bool called_register_command_;
 
   // The cached value of whether or not the action wants to run on the current
   // tab.
   bool wants_to_run_;
 
+  // Indicates if menu is currently showing.
+  bool menu_showing_;
+
   // Responsible for running the menu.
   scoped_ptr<views::MenuRunner> menu_runner_;
 
   // If non-null, this is the next toolbar action context menu that wants to run
   // once the current owner (this one) is done.
   base::Closure followup_context_menu_task_;
 
   // The time the popup was last closed.
   base::TimeTicks popup_closed_time_;
 
   content::NotificationRegistrar registrar_;
 
+  // Animation controller for the ink drop ripple effect.
+  scoped_ptr<views::InkDropAnimationController> ink_drop_animation_controller_;
+
+  scoped_ptr<views::InkDropDelegate> ink_drop_delegate_;
+
   base::WeakPtrFactory<ToolbarActionView> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(ToolbarActionView);
 };
 
 #endif  // CHROME_BROWSER_UI_VIEWS_TOOLBAR_TOOLBAR_ACTION_VIEW_H_