Adds OnClickCanceled callback to views::Button

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"
@@ skipping 76 matching lines @@
   }
   return size;
 }
 
 void ToolbarButton::Layout() {
   LabelButton::Layout();
   ink_drop_animation_controller_->SetInkDropCenter(CalculateInkDropCenter());
 }
 
 bool ToolbarButton::OnMousePressed(const ui::MouseEvent& event) {
-  if (enabled() && ShouldShowMenu() &&
-      IsTriggerableEvent(event) && HitTestPoint(event.location())) {
-    // Store the y pos of the mouse coordinates so we can use them later to
-    // determine if the user dragged the mouse down (which should pop up the
-    // drag down menu immediately, instead of waiting for the timer)
-    y_position_on_lbuttondown_ = event.y();
+  if (IsTriggerableEvent(event)) {
+    if (enabled() && ShouldShowMenu() && HitTestPoint(event.location())) {
+      // Store the y pos of the mouse coordinates so we can use them later to
+      // determine if the user dragged the mouse down (which should pop up the
+      // drag down menu immediately, instead of waiting for the timer)
+      y_position_on_lbuttondown_ = event.y();
 
-    // 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));
-  }
-
-  // views::Button actions are only triggered by left and middle mouse clicks.
-  if (event.IsLeftMouseButton() || event.IsMiddleMouseButton()) {
+      // 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);

[sadrul, 2015/11/06 21:46:59]

I am beginning to question if event-handling code is the best place to actually
trigger/stop the animations. Would it make sense to trigger the animations
specifically when the ButtonState changes? For example, CustomButton::SetState()
can call a virtual OnStateChanged(old_state, new_state [, event?]) method, and
ToolbarButton here will override that to make the decision of when to start/stop
the ripple. If that works, I feel like that would simplify this code.

[varkha, 2015/11/09 15:22:21]

This may work as a plan (and would be applicable to other ripple targets) but
seems tangential to this CL which is just a bug fix in the existing handling.

   }
 
   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
     // it immediately.
     if (event.y() > y_position_on_lbuttondown_ + GetHorizontalDragThreshold()) {
       show_menu_factory_.InvalidateWeakPtrs();
       ShowDropDownMenu(ui::GetMenuSourceTypeForEvent(event));
     }
   }
 
   return result;
 }
 
 void ToolbarButton::OnMouseReleased(const ui::MouseEvent& event) {
   if (IsTriggerableEvent(event) ||
       (event.IsRightMouseButton() && !HitTestPoint(event.location()))) {
     LabelButton::OnMouseReleased(event);
   }
 
   if (IsTriggerableEvent(event))
     show_menu_factory_.InvalidateWeakPtrs();
-
-  if (!HitTestPoint(event.location()))
-    ink_drop_animation_controller_->AnimateToState(views::InkDropState::HIDDEN);
 }
 
 void ToolbarButton::OnMouseCaptureLost() {
 }
 
 void ToolbarButton::OnMouseExited(const ui::MouseEvent& event) {
   // Starting a drag results in a MouseExited, we need to ignore it.
   // A right click release triggers an exit event. We want to
   // remain in a PUSHED state until the drop down menu closes.
   if (state_ != STATE_DISABLED && !InDrag() && state_ != STATE_PRESSED)
@@ skipping 90 matching lines @@
          (event.IsMouseEvent() && ((ui::EF_LEFT_MOUSE_BUTTON |
              ui::EF_RIGHT_MOUSE_BUTTON) & event.flags()) != 0);
 }
 
 void ToolbarButton::NotifyClick(const ui::Event& event) {
   LabelButton::NotifyClick(event);
   ink_drop_animation_controller_->AnimateToState(
       views::InkDropState::QUICK_ACTION);
 }
 
+void ToolbarButton::OnClickCanceled(const ui::Event& event) {
+  LabelButton::OnClickCanceled(event);
+  ink_drop_animation_controller_->AnimateToState(views::InkDropState::HIDDEN);
+}
+
 bool ToolbarButton::ShouldShowMenu() {
   return model_ != nullptr;
 }
 
 void ToolbarButton::ShowDropDownMenu(ui::MenuSourceType source_type) {
   if (!ShouldShowMenu())
     return;
 
   gfx::Rect lb = GetLocalBounds();
 
@@ skipping 73 matching lines @@
     SetState(STATE_NORMAL);
 }
 
 gfx::Point ToolbarButton::CalculateInkDropCenter() const {
   return GetLocalBounds().CenterPoint();
 }
 
 const char* ToolbarButton::GetClassName() const {
   return "ToolbarButton";
 }