Keep reference view pressed while extension actions have a popup

ui/views/controls/button/menu_button.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/menu_button.h"
 
 #include "base/strings/utf_string_conversions.h"
 #include "ui/accessibility/ax_view_state.h"
 #include "ui/base/dragdrop/drag_drop_types.h"
 #include "ui/base/l10n/l10n_util.h"
@@ skipping 21 matching lines @@
 static const int kDefaultMenuOffsetX = -2;
 static const int kDefaultMenuOffsetY = -4;
 
 // static
 const char MenuButton::kViewClassName[] = "MenuButton";
 const int MenuButton::kMenuMarkerPaddingLeft = 3;
 const int MenuButton::kMenuMarkerPaddingRight = -1;
 
 ////////////////////////////////////////////////////////////////////////////////
 //
+// MenuButton::PressedLock
+//
+////////////////////////////////////////////////////////////////////////////////
+
+MenuButton::PressedLock::PressedLock(MenuButton* menu_button)
+    : menu_button_(menu_button->weak_factory_.GetWeakPtr()) {
+  menu_button_->IncrementPressedLocked();
+}
+
+MenuButton::PressedLock::~PressedLock() {
+  if (menu_button_.get())
+    menu_button_->DecrementPressedLocked();
+}
+
+////////////////////////////////////////////////////////////////////////////////
+//
 // MenuButton - constructors, destructors, initialization
 //
 ////////////////////////////////////////////////////////////////////////////////
 
 MenuButton::MenuButton(ButtonListener* listener,
                        const base::string16& text,
                        MenuButtonListener* menu_button_listener,
                        bool show_menu_marker)
     : LabelButton(listener, text),
-      menu_visible_(false),
       menu_offset_(kDefaultMenuOffsetX, kDefaultMenuOffsetY),
       listener_(menu_button_listener),
       show_menu_marker_(show_menu_marker),
       menu_marker_(ui::ResourceBundle::GetSharedInstance().GetImageNamed(
           IDR_MENU_DROPARROW).ToImageSkia()),
-      destroyed_flag_(NULL) {
+      destroyed_flag_(NULL),
+      pressed_lock_count_(0),
+      weak_factory_(this) {
   SetHorizontalAlignment(gfx::ALIGN_LEFT);
 }
 
 MenuButton::~MenuButton() {
   if (destroyed_flag_)
     *destroyed_flag_ = true;
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 //
@@ skipping 25 matching lines @@
     // We're about to show the menu from a mouse press. By showing from the
     // mouse press event we block RootView in mouse dispatching. This also
     // appears to cause RootView to get a mouse pressed BEFORE the mouse
     // release is seen, which means RootView sends us another mouse press no
     // matter where the user pressed. To force RootView to recalculate the
     // mouse target during the mouse press we explicitly set the mouse handler
     // to NULL.
     static_cast<internal::RootView*>(GetWidget()->GetRootView())->
         SetMouseHandler(NULL);
 
-    menu_visible_ = true;
-
     bool destroyed = false;
     destroyed_flag_ = &destroyed;
 
+    // We don't set our state here. It's handled in the MenuController code or
+    // by our click listener.
+
     listener_->OnMenuButtonClicked(this, menu_position);
 
     if (destroyed) {
       // The menu was deleted while showing. Don't attempt any processing.
       return false;
     }
 
     destroyed_flag_ = NULL;
 
-    menu_visible_ = false;
     menu_closed_time_ = TimeTicks::Now();
 
-    // Now that the menu has closed, we need to manually reset state to
-    // "normal" since the menu modal loop will have prevented normal
-    // mouse move messages from getting to this View. We set "normal"
-    // and not "hot" because the likelihood is that the mouse is now
-    // somewhere else (user clicked elsewhere on screen to close the menu
-    // or selected an item) and we will inevitably refresh the hot state
-    // in the event the mouse _is_ over the view.
-    SetState(STATE_NORMAL);
-
     // We must return false here so that the RootView does not get stuck
     // sending all mouse pressed events to us instead of the appropriate
     // target.
     return false;
   }
   return true;
 }
 
 void MenuButton::OnPaint(gfx::Canvas* canvas) {
   LabelButton::OnPaint(canvas);
@@ skipping 16 matching lines @@
                      0);
   }
   return prefsize;
 }
 
 const char* MenuButton::GetClassName() const {
   return kViewClassName;
 }
 
 bool MenuButton::OnMousePressed(const ui::MouseEvent& event) {
   RequestFocus();

[sky, 2014/09/22 16:06:11]

Don't you want to ignore pressed/released too?

[Devlin, 2014/09/22 16:22:37]

I don't think we do.  I think that we only want to allow locking PRESSED to mean
that state won't be updated from mouse movements, versus also blocking mouse
events that typically invoke an action.  If a view wants to ignore mouse
clicks/gesture taps, I would think that it would do so by another method, e.g.
blocking the run loop and requiring capture (as a menu does).

Also, it would lead to, in my opinion, strange behavior - the menu button that
is clicked does not respond to clicks, but other menu buttons (even those of the
exact same type) do - something which seems very inconsistent.

   if (state() != STATE_DISABLED) {
     // If we're draggable (GetDragOperations returns a non-zero value), then
     // don't pop on press, instead wait for release.
     if (event.IsOnlyLeftMouseButton() &&
         HitTestPoint(event.location()) &&
         GetDragOperations(event.location()) == ui::DragDropTypes::DRAG_NONE) {
       TimeDelta delta = TimeTicks::Now() - menu_closed_time_;
       if (delta.InMilliseconds() > kMinimumMsBetweenButtonClicks)
         return Activate();
     }
   }
   return true;
 }
 
 void MenuButton::OnMouseReleased(const ui::MouseEvent& event) {
   // Explicitly test for left mouse button to show the menu. If we tested for
   // !IsTriggerableEvent it could lead to a situation where we end up showing
   // the menu and context menu (this would happen if the right button is not
   // triggerable and there's a context menu).
   if (GetDragOperations(event.location()) != ui::DragDropTypes::DRAG_NONE &&
       state() != STATE_DISABLED && !InDrag() && event.IsOnlyLeftMouseButton() &&
       HitTestPoint(event.location())) {
     Activate();
   } else {
     LabelButton::OnMouseReleased(event);
   }
 }
 
-// The reason we override View::OnMouseExited is because we get this event when
-// we display the menu. If we don't override this method then
-// BaseButton::OnMouseExited will get the event and will set the button's state
-// to STATE_NORMAL instead of keeping the state BM_PUSHED. This, in turn, will
-// cause the button to appear depressed while the menu is displayed.
+void MenuButton::OnMouseEntered(const ui::MouseEvent& event) {
+  if (pressed_lock_count_ == 0)  // Ignore mouse movement if state is locked.
+    CustomButton::OnMouseEntered(event);
+}
+
 void MenuButton::OnMouseExited(const ui::MouseEvent& event) {
-  if ((state_ != STATE_DISABLED) && (!menu_visible_) && (!InDrag())) {
-    SetState(STATE_NORMAL);
-  }
+  if (pressed_lock_count_ == 0)  // Ignore mouse movement if state is locked.
+    CustomButton::OnMouseExited(event);
+}
+
+void MenuButton::OnMouseMoved(const ui::MouseEvent& event) {
+  if (pressed_lock_count_ == 0)  // Ignore mouse movement if state is locked.
+    CustomButton::OnMouseMoved(event);
 }
 
 void MenuButton::OnGestureEvent(ui::GestureEvent* event) {
   if (state() != STATE_DISABLED && event->type() == ui::ET_GESTURE_TAP &&

[sky, 2014/09/22 16:06:11]

Don't you need to early out here too?

[Devlin, 2014/09/22 16:22:37]

See above.

       !Activate()) {
     // When |Activate()| returns |false|, it means that a menu is shown and
     // has handled the gesture event. So, there is no need to further process
     // the gesture event here.
     return;
   }
   LabelButton::OnGestureEvent(event);
 }
 
 bool MenuButton::OnKeyPressed(const ui::KeyEvent& event) {
@@ skipping 51 matching lines @@
   gfx::Size s = size();
 
   if (show_menu_marker_) {
     s.set_width(s.width() - menu_marker_->width() - kMenuMarkerPaddingLeft -
                 kMenuMarkerPaddingRight);
   }
 
   return gfx::Rect(s);
 }
 
+void MenuButton::IncrementPressedLocked() {
+  ++pressed_lock_count_;
+  SetState(STATE_PRESSED);
+}
+
+void MenuButton::DecrementPressedLocked() {
+  --pressed_lock_count_;
+  DCHECK_GE(pressed_lock_count_, 0);
+
+  // If this was the last lock, manually reset state to "normal". We set
+  // "normal" and not "hot" because the likelihood is that the mouse is now
+  // somewhere else (user clicked elsewhere on screen to close the menu or
+  // selected an item) and we will inevitably refresh the hot state in the event
+  // the mouse _is_ over the view.
+  if (pressed_lock_count_ == 0)
+    SetState(STATE_NORMAL);
+}
+
 int MenuButton::GetMaximumScreenXCoordinate() {
   if (!GetWidget()) {
     NOTREACHED();
     return 0;
   }
 
   gfx::Rect monitor_bounds = GetWidget()->GetWorkAreaBoundsInScreen();
   return monitor_bounds.right() - 1;
 }
 
 }  // namespace views