Implemented prototype for new ink drop specs.

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

 // 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.
 
 #include "chrome/browser/ui/views/toolbar/toolbar_button.h"
 
 #include "base/bind.h"
 #include "base/location.h"
 #include "base/single_thread_task_runner.h"
 #include "base/thread_task_runner_handle.h"
 #include "chrome/browser/themes/theme_properties.h"
 #include "chrome/browser/ui/views/location_bar/location_bar_view.h"
 #include "ui/accessibility/ax_view_state.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/models/menu_model.h"
 #include "ui/base/resource/material_design/material_design_controller.h"
 #include "ui/base/theme_provider.h"
 #include "ui/gfx/display.h"
 #include "ui/gfx/screen.h"
 #include "ui/strings/grit/ui_strings.h"
 #include "ui/views/animation/ink_drop_animation_controller.h"
 #include "ui/views/animation/ink_drop_animation_controller_factory.h"
 #include "ui/views/controls/button/label_button_border.h"
 #include "ui/views/controls/menu/menu_item_view.h"
 #include "ui/views/controls/menu/menu_model_adapter.h"
 #include "ui/views/controls/menu/menu_runner.h"
 #include "ui/views/widget/widget.h"
 
+// Sizes for the the ink drop.
+const int kInkDropLargeSize = 32;

[Peter Kasting, 2015/09/03 21:53:06]

Nit: Move all these to LayoutInkDrop() since that's the only consumer.

[bruthig, 2015/09/09 18:00:35]

Done.

+const int kInkDropLargeCornerRadius = 5;
+const int kInkDropSmallSize = 24;
+const int kInkDropSmallCornerRadius = 2;
+
 ToolbarButton::ToolbarButton(views::ButtonListener* listener,
                              ui::MenuModel* model)
     : views::LabelButton(listener, base::string16()),
       model_(model),
       menu_showing_(false),
       y_position_on_lbuttondown_(0),
       show_menu_factory_(this) {
   ink_drop_animation_controller_ = views::InkDropAnimationControllerFactory::
       CreateInkDropAnimationController(this);
   set_context_menu_controller(this);
@@ skipping 53 matching lines @@
 
     // Schedule a task that will show the menu.
     const int kMenuTimerDelay = 500;
     base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
         FROM_HERE, base::Bind(&ToolbarButton::ShowDropDownMenu,
                               show_menu_factory_.GetWeakPtr(),
                               ui::GetMenuSourceTypeForEvent(event)),
         base::TimeDelta::FromMilliseconds(kMenuTimerDelay));
   }
 
-  ink_drop_animation_controller_->AnimateToState(
-      views::InkDropState::ACTION_PENDING);
+  // Button actions are only triggered by left and middle mouse clicks.

[Peter Kasting, 2015/09/03 21:53:06]

Today in Chrome I can right-click the back button and immediately get a dropdown
of my session history.  Does that falsify this statement?

[bruthig, 2015/09/09 18:00:35]

No it does not, the menu shown due to a right-click is handled by
ToolbarButton::OnMousePressed()->ToolbarButton::ShowDropDownMenu().  I've tried
to reduce the ambiguity by adding the 'views::' prefix.

+  if (event.IsLeftMouseButton() || event.IsMiddleMouseButton()) {
+    ink_drop_animation_controller_->AnimateToState(
+        views::InkDropState::ACTION_PENDING);
+  }
 
   return LabelButton::OnMousePressed(event);
 }
 
 bool ToolbarButton::OnMouseDragged(const ui::MouseEvent& event) {
   bool result = LabelButton::OnMouseDragged(event);
 
   if (show_menu_factory_.HasWeakPtrs()) {
     // If the mouse is dragged to a y position lower than where it was when
     // clicked then we should not wait for the menu to appear but show
@@ skipping 41 matching lines @@
 
   views::InkDropState ink_drop_state = views::InkDropState::HIDDEN;
   switch (event->type()) {
     case ui::ET_GESTURE_TAP_DOWN:
       ink_drop_state = views::InkDropState::ACTION_PENDING;
       // The ui::ET_GESTURE_TAP_DOWN event needs to be marked as handled so that
       // subsequent events for the gesture are sent to |this|.
       event->SetHandled();
       break;
     case ui::ET_GESTURE_LONG_PRESS:
-      ink_drop_state = views::InkDropState::SLOW_ACTION;
+      ink_drop_state = views::InkDropState::SLOW_ACTION_PENDING;
       break;
     case ui::ET_GESTURE_TAP:
       ink_drop_state = views::InkDropState::QUICK_ACTION;
       break;
+    case ui::ET_GESTURE_LONG_TAP:
+      ink_drop_state = views::InkDropState::SLOW_ACTION;
+      break;
     case ui::ET_GESTURE_END:
     case ui::ET_GESTURE_TAP_CANCEL:
       ink_drop_state = views::InkDropState::HIDDEN;
       break;
     default:
       return;
   }
   ink_drop_animation_controller_->AnimateToState(ink_drop_state);
 }
 
@@ skipping 50 matching lines @@
 bool ToolbarButton::ShouldEnterPushedState(const ui::Event& event) {
   // Enter PUSHED state on press with Left or Right mouse button or on taps.
   // Remain in this state while the context menu is open.
   return event.type() == ui::ET_GESTURE_TAP ||
          event.type() == ui::ET_GESTURE_TAP_DOWN ||
          (event.IsMouseEvent() && ((ui::EF_LEFT_MOUSE_BUTTON |
              ui::EF_RIGHT_MOUSE_BUTTON) & event.flags()) != 0);
 }
 
 bool ToolbarButton::ShouldShowMenu() {
-  return model_ != NULL;
+  return model_ != nullptr;
 }
 
 void ToolbarButton::ShowDropDownMenu(ui::MenuSourceType source_type) {
   if (!ShouldShowMenu())
     return;
 
   gfx::Rect lb = GetLocalBounds();
 
   // Both the menu position and the menu anchor type change if the UI layout
   // is right-to-left.
@@ skipping 24 matching lines @@
   int left_bound = display.bounds().x();
 #endif
   if (menu_position.x() < left_bound)
     menu_position.set_x(left_bound);
 
   // Make the button look depressed while the menu is open.
   SetState(STATE_PRESSED);
 
   menu_showing_ = true;
 
+  views::MenuRunner::RunResult result = views::MenuRunner::MENU_DELETED;
+  ink_drop_animation_controller_->AnimateToState(
+      views::InkDropState::ACTIVATED);
+
   // Create and run menu.  Display an empty menu if model is NULL.
   if (model_.get()) {
     views::MenuModelAdapter menu_delegate(model_.get());
     menu_delegate.set_triggerable_event_flags(triggerable_event_flags());
     menu_runner_.reset(new views::MenuRunner(menu_delegate.CreateMenu(),
                                              views::MenuRunner::HAS_MNEMONICS));
-    views::MenuRunner::RunResult result =
-        menu_runner_->RunMenuAt(GetWidget(),
-                                NULL,
-                                gfx::Rect(menu_position, gfx::Size(0, 0)),
-                                views::MENU_ANCHOR_TOPLEFT,
-                                source_type);
-    if (result == views::MenuRunner::MENU_DELETED)
-      return;
+    result = menu_runner_->RunMenuAt(GetWidget(), nullptr,

[Peter Kasting, 2015/09/03 21:53:06]

Is it safe to move this block below the conditional, since both arms do the same
thing?  Or does RunMenuAt() need to be called while |menu_delegate| is alive?

[bruthig, 2015/09/09 18:00:35]

Negative, as you suspect |menu_delegate| must be alive when RunMenuAt() is
called.

+                                     gfx::Rect(menu_position, gfx::Size(0, 0)),
+                                     views::MENU_ANCHOR_TOPLEFT, source_type);
   } else {
     views::MenuDelegate menu_delegate;
     views::MenuItemView* menu = new views::MenuItemView(&menu_delegate);
     menu_runner_.reset(
         new views::MenuRunner(menu, views::MenuRunner::HAS_MNEMONICS));
-    views::MenuRunner::RunResult result =
-        menu_runner_->RunMenuAt(GetWidget(),
-                                NULL,
-                                gfx::Rect(menu_position, gfx::Size(0, 0)),
-                                views::MENU_ANCHOR_TOPLEFT,
-                                source_type);
-    if (result == views::MenuRunner::MENU_DELETED)
-      return;
+    result = menu_runner_->RunMenuAt(GetWidget(), nullptr,
+                                     gfx::Rect(menu_position, gfx::Size(0, 0)),
+                                     views::MENU_ANCHOR_TOPLEFT, source_type);
   }
 
-  ink_drop_animation_controller_->AnimateToState(views::InkDropState::HIDDEN);
+  ink_drop_animation_controller_->AnimateToState(

[Peter Kasting, 2015/09/03 21:53:06]

This isn't safe if the result is MENU_DELETED, in that case |this| is null.  You
must return before calling this.

[bruthig, 2015/09/09 18:00:35]

Done. I've also added a comment to try and make this more obvious.

+      views::InkDropState::DEACTIVATED);
+  if (result == views::MenuRunner::MENU_DELETED)
+    return;
 
   menu_showing_ = false;
 
   // Need to explicitly clear mouse handler so that events get sent
   // properly after the menu finishes running. If we don't do this, then
   // the first click to other parts of the UI is eaten.
-  SetMouseHandler(NULL);
+  SetMouseHandler(nullptr);
 
   // Set the state back to normal after the drop down menu is closed.
   if (state_ != STATE_DISABLED)
     SetState(STATE_NORMAL);
 }
 
 void ToolbarButton::LayoutInkDrop() {
-  ink_drop_animation_controller_->SetInkDropSize(size());
+  gfx::Size ink_drop_size = gfx::Size(kInkDropLargeSize, kInkDropLargeSize);

[Peter Kasting, 2015/09/03 21:53:06]

Nit: I don't see why you made a temp for this instead of doing it inline like is
done for the small size.

[bruthig, 2015/09/09 18:00:35]

Done.  Oversight on my part.

+  ink_drop_animation_controller_->SetInkDropSize(
+      ink_drop_size, kInkDropLargeCornerRadius,
+      gfx::Size(kInkDropSmallSize, kInkDropSmallSize),
+      kInkDropSmallCornerRadius);
+  ink_drop_animation_controller_->SetInkDropCenter(
+      gfx::Point(width() / 2, height() / 2));
+}
+
+void ToolbarButton::NotifyClick(const ui::Event& event) {
+  ink_drop_animation_controller_->AnimateToState(
+      views::InkDropState::QUICK_ACTION);
+  LabelButton::NotifyClick(event);
 }
 
 const char* ToolbarButton::GetClassName() const {
   return "ToolbarButton";
 }