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 "base/callback.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 {
@@ skipping 10 matching lines @@
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // 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 22 matching lines @@
 
   // views::MenuButtonListener:
   void OnMenuButtonClicked(views::View* sender,
                            const gfx::Point& point) override;
 
   // content::NotificationObserver:
   void Observe(int type,
                const content::NotificationSource& source,
                const content::NotificationDetails& details) override;
 
   // views::MenuButton:

[Peter Kasting, 2015/11/24 20:42:01]

WHile here: Group these MenuButton overrides with the other one above (and move
function ordering in the cc similarly)

[varkha, 2015/11/24 21:50:44]

Done.

   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).

[Peter Kasting, 2015/11/24 20:42:01]

While here: Change this base class name to ToolbarActionViewDelegateViews to
match actual parent class name, reorder relative to above override groups to
match the order in which this class declares its parents, and remove the
unnecessary description of why these methods are public.

[varkha, 2015/11/24 21:50:44]

Done.

   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_; }
 
   using ContextMenuCallback = base::Callback<void(ToolbarActionView*)>;

[Peter Kasting, 2015/11/24 20:42:01]

While here: Move this typedef up by the member class declaration to match the
style guide's prescribed order for declarations.

[varkha, 2015/11/24 21:50:44]

Done.

   // Set a callback to be called directly before the context menu is shown.
   // The toolbar action opening the menu will be passed in.
   static void set_context_menu_callback_for_testing(
       ContextMenuCallback* callback);
 
   views::MenuItemView* menu_for_testing() { return menu_; }
 
+  // views::InkDropHost:

[Peter Kasting, 2015/11/24 20:42:01]

Place this above with the other override groups.

[varkha, 2015/11/24 21:50:44]

Done.

+  void AddInkDropLayer(ui::Layer* ink_drop_layer) override;
+  void RemoveInkDropLayer(ui::Layer* ink_drop_layer) override;
+
+ protected:

[Peter Kasting, 2015/11/24 20:42:01]

Are there subclasses that actually call these?  If not, make private instead.

[varkha, 2015/11/24 21:50:44]

Done.

+  // views::InkDropHost:
+  gfx::Point CalculateInkDropCenter() const override;
+
+  // views::View:

[Peter Kasting, 2015/11/24 20:42:01]

You don't directly subclass views::View.  This should be listed as an override
of the appropriate direct parent (I assume views::MenuButton) and then the
groups of overrides for each parent ordered as noted above.

[varkha, 2015/11/24 21:50:44]

Done.

+  views::InkDropDelegate* GetInkDropDelegate() const override;
+
  private:
   // views::MenuButton:
   gfx::Size GetPreferredSize() const 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 41 matching lines @@
 
   // 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 delegate for the ink drop ripple effect.
+  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_