Adds OnClickCanceled callback to views::Button

ui/views/controls/button/custom_button_unittest.cc

 // Copyright (c) 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.
 
 #include "ui/views/controls/button/custom_button.h"
 
 #include "testing/gtest/include/gtest/gtest.h"
 #include "ui/base/layout.h"
 #include "ui/events/event_utils.h"
 #include "ui/gfx/screen.h"
@@ skipping 18 matching lines @@
 
 class TestCustomButton : public CustomButton, public ButtonListener {
  public:
   explicit TestCustomButton()
       : CustomButton(this) {
   }
 
   ~TestCustomButton() override {}
 
   void ButtonPressed(Button* sender, const ui::Event& event) override {
-    notified_ = true;
+    pressed_ = true;
   }
 
-  bool notified() { return notified_; }
+  void OnClickCanceled(const ui::Event& event) override {
+    canceled_ = true;
+  }
 
-  void Reset() { notified_ = false; }
+  bool pressed() { return pressed_; }
+  bool canceled() { return canceled_; }
+
+  void Reset() {
+    pressed_ = false;
+    canceled_ = false;
+  }
 
   // CustomButton methods:
   bool IsChildWidget() const override { return is_child_widget_; }
   bool FocusInChildWidget() const override { return focus_in_child_widget_; }
 
   void set_child_widget(bool b) { is_child_widget_ = b; }
   void set_focus_in_child_widget(bool b) { focus_in_child_widget_ = b; }
 
  private:
-  bool notified_ = false;
+  bool pressed_ = false;
+  bool canceled_ = false;
   bool is_child_widget_ = false;
   bool focus_in_child_widget_ = false;
 
   DISALLOW_COPY_AND_ASSIGN(TestCustomButton);
 };
 
 class TestWidget : public Widget {
  public:
   TestWidget() : Widget() {}
 
@@ skipping 130 matching lines @@
 
 // Tests the different types of NotifyActions.
 TEST_F(CustomButtonTest, NotifyAction) {
   gfx::Point center(10, 10);
 
   // By default the button should notify its listener on mouse release.
   button()->OnMousePressed(ui::MouseEvent(
       ui::ET_MOUSE_PRESSED, center, center, ui::EventTimeForNow(),
       ui::EF_LEFT_MOUSE_BUTTON, ui::EF_LEFT_MOUSE_BUTTON));
   EXPECT_EQ(CustomButton::STATE_PRESSED, button()->state());
-  EXPECT_FALSE(button()->notified());
+  EXPECT_FALSE(button()->pressed());
 
   button()->OnMouseReleased(ui::MouseEvent(
       ui::ET_MOUSE_RELEASED, center, center, ui::EventTimeForNow(),
       ui::EF_LEFT_MOUSE_BUTTON, ui::EF_LEFT_MOUSE_BUTTON));
   EXPECT_EQ(CustomButton::STATE_HOVERED, button()->state());
-  EXPECT_TRUE(button()->notified());
+  EXPECT_TRUE(button()->pressed());
 
   // Set the notify action to its listener on mouse press.
   button()->Reset();
   button()->set_notify_action(CustomButton::NOTIFY_ON_PRESS);
   button()->OnMousePressed(ui::MouseEvent(
       ui::ET_MOUSE_PRESSED, center, center, ui::EventTimeForNow(),
       ui::EF_LEFT_MOUSE_BUTTON, ui::EF_LEFT_MOUSE_BUTTON));
   EXPECT_EQ(CustomButton::STATE_PRESSED, button()->state());
-  EXPECT_TRUE(button()->notified());
+  EXPECT_TRUE(button()->pressed());
 
   // The button should no longer notify on mouse release.
   button()->Reset();
   button()->OnMouseReleased(ui::MouseEvent(
       ui::ET_MOUSE_RELEASED, center, center, ui::EventTimeForNow(),
       ui::EF_LEFT_MOUSE_BUTTON, ui::EF_LEFT_MOUSE_BUTTON));
   EXPECT_EQ(CustomButton::STATE_HOVERED, button()->state());
-  EXPECT_FALSE(button()->notified());
+  EXPECT_FALSE(button()->pressed());
 }
 
 TEST_F(CustomButtonTest, HandleAccelerator) {
   // Child widgets shouldn't handle accelerators when they are not focused.
   EXPECT_FALSE(button()->IsChildWidget());
   EXPECT_FALSE(button()->FocusInChildWidget());
   EXPECT_FALSE(widget()->IsActive());
   button()->AcceleratorPressed(ui::Accelerator(ui::VKEY_RETURN, ui::EF_NONE));
-  EXPECT_FALSE(button()->notified());
+  EXPECT_FALSE(button()->pressed());
   // Child without focus.
   button()->set_child_widget(true);
   button()->set_focus_in_child_widget(false);
   button()->AcceleratorPressed(ui::Accelerator(ui::VKEY_RETURN, ui::EF_NONE));
-  EXPECT_FALSE(button()->notified());
+  EXPECT_FALSE(button()->pressed());
   button()->Reset();
   // Child with focus.
   button()->set_child_widget(true);
   button()->set_focus_in_child_widget(true);
   button()->AcceleratorPressed(ui::Accelerator(ui::VKEY_RETURN, ui::EF_NONE));
-  EXPECT_TRUE(button()->notified());
+  EXPECT_TRUE(button()->pressed());
   button()->Reset();
   // Not a child, but active.
   button()->set_child_widget(false);
   button()->set_focus_in_child_widget(true);
   widget()->set_active(true);
   button()->AcceleratorPressed(ui::Accelerator(ui::VKEY_RETURN, ui::EF_NONE));
-  EXPECT_TRUE(button()->notified());
+  EXPECT_TRUE(button()->pressed());
+}
+
+// Tests that OnClickCanceled gets called when NotifyClick is not expected
+// anymore.
+TEST_F(CustomButtonTest, NotifyActionNoClick) {
+  gfx::Point center(10, 10);
+
+  // By default the button should notify its listener on mouse release.
+  button()->OnMousePressed(ui::MouseEvent(
+      ui::ET_MOUSE_PRESSED, center, center, ui::EventTimeForNow(),
+      ui::EF_RIGHT_MOUSE_BUTTON, ui::EF_RIGHT_MOUSE_BUTTON));
+  EXPECT_FALSE(button()->canceled());
+
+  button()->OnMouseReleased(ui::MouseEvent(
+      ui::ET_MOUSE_RELEASED, center, center, ui::EventTimeForNow(),
+      ui::EF_RIGHT_MOUSE_BUTTON, ui::EF_RIGHT_MOUSE_BUTTON));
+  EXPECT_TRUE(button()->canceled());
+
+  // Set the notify action to its listener on mouse press.
+  button()->Reset();
+  button()->set_notify_action(CustomButton::NOTIFY_ON_PRESS);
+  button()->OnMousePressed(ui::MouseEvent(
+      ui::ET_MOUSE_PRESSED, center, center, ui::EventTimeForNow(),
+      ui::EF_RIGHT_MOUSE_BUTTON, ui::EF_RIGHT_MOUSE_BUTTON));
+  // OnClickCanceled is only sent on mouse release.
+  EXPECT_FALSE(button()->canceled());
+
+  // The button should no longer notify on mouse release.
+  button()->Reset();
+  button()->OnMouseReleased(ui::MouseEvent(
+      ui::ET_MOUSE_RELEASED, center, center, ui::EventTimeForNow(),
+      ui::EF_RIGHT_MOUSE_BUTTON, ui::EF_RIGHT_MOUSE_BUTTON));
+  EXPECT_FALSE(button()->canceled());
 }
 
 // No touch on desktop Mac. Tracked in http://crbug.com/445520.
 #if !defined(OS_MACOSX) || defined(USE_AURA)
 
 namespace {
 
 void PerformGesture(CustomButton* button, ui::EventType event_type) {
   ui::GestureEventDetails gesture_details(event_type);
   base::TimeDelta time_stamp = base::TimeDelta::FromMicroseconds(0);
@@ skipping 45 matching lines @@
   EXPECT_FALSE(CustomButton::AsCustomButton(&label));
 
   Link link(text);
   EXPECT_FALSE(CustomButton::AsCustomButton(&link));
 
   Textfield textfield;
   EXPECT_FALSE(CustomButton::AsCustomButton(&textfield));
 }
 
 }  // namespace views