Google Git
Sign in
chromium / codesearch / chromium / src / HEAD / . / ui / views / controls / menu / menu_controller.cc
blob: f827a572f1edf0d62dd9aeddbb4adc638144814e [file] [log] [blame]
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ui/views/controls/menu/menu_controller.h"
#include <algorithm>
#include <set>
#include <utility>
#include "base/callback_list.h"
#include "base/check.h"
#include "base/containers/flat_set.h"
#include "base/debug/dump_without_crashing.h"
#include "base/functional/bind.h"
#include "base/i18n/case_conversion.h"
#include "base/i18n/rtl.h"
#include "base/memory/raw_ptr.h"
#include "base/numerics/safe_conversions.h"
#include "base/strings/utf_string_conversions.h"
#include "base/task/single_thread_task_runner.h"
#include "base/time/time.h"
#include "build/build_config.h"
#include "components/crash/core/common/crash_key.h"
#include "ui/base/dragdrop/drag_drop_types.h"
#include "ui/base/dragdrop/mojom/drag_drop_types.mojom.h"
#include "ui/base/dragdrop/os_exchange_data.h"
#include "ui/base/mojom/menu_source_type.mojom.h"
#include "ui/base/owned_window_anchor.h"
#include "ui/base/ui_base_types.h"
#include "ui/display/display.h"
#include "ui/display/screen.h"
#include "ui/events/event.h"
#include "ui/events/event_utils.h"
#include "ui/gfx/canvas.h"
#include "ui/gfx/geometry/point.h"
#include "ui/gfx/geometry/vector2d.h"
#include "ui/gfx/image/image.h"
#include "ui/gfx/image/image_skia.h"
#include "ui/gfx/image/image_skia_rep.h"
#include "ui/gfx/native_ui_types.h"
#include "ui/native_theme/native_theme.h"
#include "ui/views/accessibility/view_accessibility.h"
#include "ui/views/controls/button/menu_button.h"
#include "ui/views/controls/menu/menu_config.h"
#include "ui/views/controls/menu/menu_controller_delegate.h"
#include "ui/views/controls/menu/menu_host_root_view.h"
#include "ui/views/controls/menu/menu_item_view.h"
#include "ui/views/controls/menu/menu_pre_target_handler.h"
#include "ui/views/controls/menu/menu_scroll_view_container.h"
#include "ui/views/controls/menu/menu_types.h"
#include "ui/views/controls/menu/submenu_view.h"
#include "ui/views/drag_utils.h"
#include "ui/views/interaction/element_tracker_views.h"
#include "ui/views/mouse_constants.h"
#include "ui/views/style/platform_style.h"
#include "ui/views/view.h"
#include "ui/views/view_class_properties.h"
#include "ui/views/view_constants.h"
#include "ui/views/view_tracker.h"
#include "ui/views/view_utils.h"
#include "ui/views/views_delegate.h"
#include "ui/views/widget/root_view.h"
#include "ui/views/widget/tooltip_manager.h"
#include "ui/views/widget/widget.h"
#if BUILDFLAG(IS_WIN)
#include "ui/aura/client/screen_position_client.h"
#include "ui/aura/window_event_dispatcher.h"
#include "ui/aura/window_tree_host.h"
#include "ui/base/win/internal_constants.h"
#include "ui/display/win/screen_win.h"
#include "ui/views/win/hwnd_util.h"
#endif
#if defined(USE_AURA)
#include "ui/aura/window.h"
#include "ui/aura/window_delegate.h"
#endif
#if BUILDFLAG(IS_OZONE)
#include "ui/ozone/public/ozone_platform.h"
#endif
using ui::OSExchangeData;
DEFINE_UI_CLASS_PROPERTY_TYPE(std::vector<views::ViewTracker>*)
namespace views {
namespace {
// TODO(crbug.com/374313509): Remove once the investigation concludes and the
// clamp asserts are avoided.
int ClampWithCrashKeys(int value,
int low,
int high,
const gfx::Rect& anchor_bounds,
const gfx::Rect& menu_bounds,
const gfx::Rect& monitor_bounds,
const gfx::Insets& border_insets = {}) {
if (low > high) {
static crash_reporter::CrashKeyString<64> anchor_bounds_key(
"anchor_bounds");
anchor_bounds_key.Set(anchor_bounds.ToString());
static crash_reporter::CrashKeyString<64> menu_bounds_key("menu_bounds");
menu_bounds_key.Set(menu_bounds.ToString());
static crash_reporter::CrashKeyString<64> monitor_bounds_key(
"monitor_bounds");
monitor_bounds_key.Set(monitor_bounds.ToString());
static crash_reporter::CrashKeyString<64> border_insets_key(
"border_insets");
border_insets_key.Set(border_insets.ToString());
CHECK_LE(low, high);
}
return std::clamp(value, low, high);
}
enum class MenuPartType { kNone, kMenuItem, kScrollUp, kScrollDown };
// The menu controller manages the AX index attributes inside menu items. This
// property maintains a vector of menu children that were last assigned such
// attributes by MenuController::SetSelectionIndices() so that the controller
// can update them if children change via MenuController::MenuChildrenChanged().
DEFINE_OWNED_UI_CLASS_PROPERTY_KEY(std::vector<views::ViewTracker>,
kOrderedMenuChildren)
#if BUILDFLAG(IS_MAC)
bool AcceleratorShouldCancelMenu(const ui::Accelerator& accelerator) {
// Since AcceleratorShouldCancelMenu() is called quite early in key
// event handling, it is actually invoked for modifier keys themselves
// changing. In that case, the key code reflects that the modifier key is
// being pressed/released. We should never treat those presses as
// accelerators, so bail out here.
//
// Also, we have to check for VKEY_SHIFT here even though we don't check
// IsShiftDown() - otherwise this sequence of keypresses will dismiss the
// menu:
// Press Cmd
// Press Shift
// Which makes it impossible to use menus that have Cmd-Shift accelerators.
if (accelerator.key_code() == ui::VKEY_CONTROL ||
accelerator.key_code() == ui::VKEY_MENU || // aka Alt
accelerator.key_code() == ui::VKEY_COMMAND ||
accelerator.key_code() == ui::VKEY_RIGHT_COMMAND ||
accelerator.key_code() == ui::VKEY_SHIFT) {
return false;
}
// Using an accelerator on Mac closes any open menu. Note that Mac behavior is
// different between context menus (which block use of accelerators) and other
// types of menus, which close when an accelerator is sent and do repost the
// accelerator. In MacViews, this happens naturally because context menus are
// (modal) Cocoa menus and other menus are Views menus, which will go through
// this code path.
return accelerator.IsCtrlDown() || accelerator.IsAltDown() ||
accelerator.IsCmdDown();
}
#endif
bool ShouldIgnoreScreenBoundsForMenus() {
#if BUILDFLAG(IS_OZONE)
// Some platforms, such as Wayland, disallow client applications to manipulate
// global screen coordinates, requiring menus to be positioned relative to
// their parent windows. See comment in ozone_platform_wayland.cc.
return !ui::OzonePlatform::GetInstance()
->GetPlatformProperties()
.supports_global_screen_coordinates;
#else
return false;
#endif
}
bool PlatformSetsParentForNonTopLevelWindows() {
#if BUILDFLAG(IS_OZONE)
return ui::OzonePlatform::GetInstance()
->GetPlatformProperties()
.set_parent_for_non_top_level_windows;
#else
return false;
#endif
}
// The amount of time the mouse should be down before a mouse release is
// considered intentional. This is to prevent spurious mouse releases from
// activating controls, especially when some UI element is revealed under the
// source of the activation (ex. menus showing underneath menu buttons).
base::TimeDelta menu_selection_hold_time = base::Milliseconds(200);
// Amount of time from when the drop exits the menu and the menu is hidden.
constexpr int kCloseOnExitTime = 1200;
// If a context menu is invoked by touch, we shift the menu by this offset so
// that the finger does not obscure the menu.
constexpr int kTouchYPadding = 15;
// The spacing offset for the bubble tip.
constexpr int kBubbleTipSizeLeftRight = 12;
constexpr int kBubbleTipSizeTopBottom = 11;
// The maximum distance (in DIPS) that the mouse can be moved before it should
// trigger a mouse menu item activation (regardless of how long the menu has
// been showing).
constexpr float kMaximumLengthMovedToActivate = 4.0f;
// Time to complete a cycle of the menu item alert animation.
constexpr base::TimeDelta kAlertAnimationThrobDuration =
base::Milliseconds(1000);
// Returns true if the mnemonic of |menu| matches key.
bool MatchesMnemonic(MenuItemView* menu, char16_t key) {
return key != 0 && menu->GetMnemonic() == key;
}
// Returns true if |menu| doesn't have a mnemonic and first character of the its
// title is |key|.
bool TitleMatchesMnemonic(MenuItemView* menu, char16_t key) {
if (menu->GetMnemonic()) {
return false;
}
std::u16string lower_title = base::i18n::ToLower(menu->title());
return !lower_title.empty() && lower_title[0] == key;
}
// Returns the first descendant of |view| that is hot tracked.
Button* GetFirstHotTrackedView(View* view) {
if (!view) {
return nullptr;
}
Button* button = Button::AsButton(view);
if (button && button->IsHotTracked()) {
return button;
}
for (View* child : view->children()) {
Button* hot_view = GetFirstHotTrackedView(child);
if (hot_view) {
return hot_view;
}
}
return nullptr;
}
MenuPartType GetScrollButtonAt(SubmenuView* source,
const gfx::Point& location) {
MenuScrollViewContainer* scroll_view = source->GetScrollViewContainer();
if (const View* child_under_mouse =
scroll_view->GetEventHandlerForPoint(location);
child_under_mouse && child_under_mouse->GetEnabled()) {
if (child_under_mouse == scroll_view->scroll_up_button()) {
return MenuPartType::kScrollUp;
}
if (child_under_mouse == scroll_view->scroll_down_button()) {
return MenuPartType::kScrollDown;
}
}
return MenuPartType::kNone;
}
// Convenience wrappers for converting between screen coordinates and the
// coordinates of the submenu's root view. CAUTION: The latter is not the same
// as the coordinates of the submenu itself! Be careful which View you are
// treating coordinates as relative to!
gfx::Point ConvertFromScreen(const SubmenuView& submenu,
const gfx::Point& location) {
return View::ConvertPointFromScreen(submenu.GetWidget()->GetRootView(),
location);
}
gfx::Point ConvertToScreen(const SubmenuView& submenu,
const gfx::Point& location) {
return View::ConvertPointToScreen(submenu.GetWidget()->GetRootView(),
location);
}
template <typename T>
T ConvertLocatedEventForRootView(const SubmenuView& submenu,
const MenuHostRootView& root_view,
const T& event) {
T converted_event = event;
if (submenu.GetWidget()->GetRootView() != &root_view) {
converted_event.set_location(View::ConvertPointFromScreen(
&root_view, ConvertToScreen(submenu, event.location())));
}
return converted_event;
}
const SubmenuView& GetRootMenu(const SubmenuView& submenu) {
return *submenu.GetMenuItem()->GetRootMenuItem()->GetSubmenu();
}
gfx::Point GetLocationInRootMenu(const SubmenuView& submenu,
const gfx::Point& location) {
// Because the root menu and `submenu` may not be in the same widget, we need
// to round-trip through screen coordinates.
return ConvertFromScreen(GetRootMenu(submenu),
ConvertToScreen(submenu, location));
}
bool Contains(const SubmenuView& submenu, const gfx::Point& location) {
return submenu.GetWidget()->GetRootView()->GetLocalBounds().Contains(
location);
}
// Recurses through the child views of |view| returning the first view starting
// at |pos| that is focusable. Children are considered first to last.
// TODO(crbug.com/41447095): This can also return |view|, which seems
// incorrect.
View* GetFirstFocusableViewForward(View* view,
View::Views::const_iterator pos) {
for (auto i = pos; i != view->children().cend(); ++i) {
View* deepest = GetFirstFocusableViewForward(*i, (*i)->children().cbegin());
if (deepest) {
return deepest;
}
}
return view->IsFocusable() ? view : nullptr;
}
// As GetFirstFocusableViewForward(), but children are considered last to first.
View* GetFirstFocusableViewBackward(View* view,
View::Views::const_reverse_iterator pos) {
for (auto i = pos; i != view->children().crend(); ++i) {
View* deepest =
GetFirstFocusableViewBackward(*i, (*i)->children().crbegin());
if (deepest) {
return deepest;
}
}
return view->IsFocusable() ? view : nullptr;
}
// Returns the first child of |start| that is focusable.
View* GetInitialFocusableView(View* start, bool forward) {
const auto& children = start->children();
return forward ? GetFirstFocusableViewForward(start, children.cbegin())
: GetFirstFocusableViewBackward(start, children.crbegin());
}
// Returns the next view after |start_at| that is focusable. Returns null if
// there are no focusable children of |ancestor| after |start_at|.
View* GetNextFocusableView(View* ancestor, View* start_at, bool forward) {
DCHECK(ancestor->Contains(start_at));
View* parent = start_at;
do {
View* new_parent = parent->parent();
const auto pos = new_parent->FindChild(parent);
// Subtle: make_reverse_iterator() will result in an iterator that refers to
// the element before its argument, which is what we want.
View* next = forward
? GetFirstFocusableViewForward(new_parent, std::next(pos))
: GetFirstFocusableViewBackward(
new_parent, std::make_reverse_iterator(pos));
if (next) {
return next;
}
parent = new_parent;
} while (parent != ancestor);
return nullptr;
}
#if BUILDFLAG(IS_WIN)
// Determines the correct coordinates and window to repost |event| to, if it is
// a mouse or touch event.
static void RepostEventImpl(const ui::LocatedEvent* event,
const gfx::Point& screen_loc,
gfx::NativeView native_view,
gfx::NativeWindow window) {
if (!event->IsMouseEvent() && !event->IsTouchEvent()) {
// TODO(rbyers): Gesture event repost is tricky to get right
// crbug.com/170987.
DCHECK(event->IsGestureEvent());
return;
}
if (!native_view) {
return;
}
gfx::Point screen_loc_pixels =
display::win::GetScreenWin()->DIPToScreenPoint(screen_loc);
HWND target_window = ::WindowFromPoint(screen_loc_pixels.ToPOINT());
// If we don't find a native window for the HWND at the current location,
// then attempt to find a native window from its parent if one exists.
// There are HWNDs created outside views, which don't have associated
// native windows.
if (!window) {
HWND parent = ::GetParent(target_window);
if (parent) {
aura::WindowTreeHost* host =
aura::WindowTreeHost::GetForAcceleratedWidget(parent);
if (host) {
target_window = parent;
window = host->window();
}
}
}
// Convert screen_loc to pixels for the Win32 API's like WindowFromPoint,
// PostMessage/SendMessage to work correctly. These API's expect the
// coordinates to be in pixels.
if (event->IsMouseEvent()) {
HWND source_window = HWNDForNativeView(native_view);
if (!target_window || !source_window ||
GetWindowThreadProcessId(source_window, nullptr) !=
GetWindowThreadProcessId(target_window, nullptr)) {
// Even though we have mouse capture, windows generates a mouse event if
// the other window is in a separate thread. Only repost an event if
// |target_window| and |source_window| were created on the same thread,
// else double events can occur and lead to bad behavior.
return;
}
// Determine whether the click was in the client area or not.
// NOTE: WM_NCHITTEST coordinates are relative to the screen.
LPARAM coords = MAKELPARAM(screen_loc_pixels.x(), screen_loc_pixels.y());
LRESULT nc_hit_result = SendMessage(target_window, WM_NCHITTEST, 0, coords);
const bool client_area = nc_hit_result == HTCLIENT;
int window_x = screen_loc_pixels.x();
int window_y = screen_loc_pixels.y();
if (client_area) {
POINT pt = {window_x, window_y};
ScreenToClient(target_window, &pt);
window_x = pt.x;
window_y = pt.y;
}
WPARAM target = client_area ? event->native_event().wParam
: static_cast<WPARAM>(nc_hit_result);
LPARAM window_coords = MAKELPARAM(window_x, window_y);
PostMessage(target_window, event->native_event().message, target,
window_coords);
return;
}
if (!window) {
return;
}
aura::Window* root = window->GetRootWindow();
aura::client::ScreenPositionClient* spc =
aura::client::GetScreenPositionClient(root);
if (!spc) {
return;
}
gfx::Point root_loc(screen_loc);
spc->ConvertPointFromScreen(root, &root_loc);
std::unique_ptr<ui::Event> clone = event->Clone();
std::unique_ptr<ui::LocatedEvent> located_event(
static_cast<ui::LocatedEvent*>(clone.release()));
located_event->set_location(root_loc);
located_event->set_root_location(root_loc);
root->GetHost()->dispatcher()->RepostEvent(located_event.get());
}
#endif // BUILDFLAG(IS_WIN)
} // namespace
// MenuController:MenuPart ---------------------------------------------------
struct MenuController::MenuPart {
// Convenience for testing type == kScrollDown or type == kScrollUp.
bool is_scroll() const {
return type == MenuPartType::kScrollDown || type == MenuPartType::kScrollUp;
}
// Type of part.
MenuPartType type = MenuPartType::kNone;
// If type is kMenuItem, this is the menu item the mouse is over, otherwise
// this is null.
// NOTE: if type is kMenuItem and the mouse is not over a valid menu item
// but is over a menu (for example, the mouse is over a separator or
// empty menu), this is null and parent is the menu the mouse was
// clicked on.
raw_ptr<MenuItemView, DanglingUntriaged> menu = nullptr;
// If type is kMenuItem but the mouse is not over a menu item this is the
// parent of the menu item the user clicked on. Otherwise this is null.
raw_ptr<MenuItemView, DanglingUntriaged> parent = nullptr;
// This is the submenu the mouse is over.
raw_ptr<SubmenuView, DanglingUntriaged> submenu = nullptr;
// Whether the controller should apply SELECTION_OPEN_SUBMENU to this item.
bool should_submenu_show = false;
};
// MenuScrollTask --------------------------------------------------------------
// MenuScrollTask is used when the SubmenuView does not all fit on screen and
// the mouse is over the scroll up/down buttons. MenuScrollTask schedules
// itself with a RepeatingTimer. When Run is invoked MenuScrollTask scrolls
// appropriately.
class MenuController::MenuScrollTask {
public:
MenuScrollTask() = default;
MenuScrollTask(const MenuScrollTask&) = delete;
MenuScrollTask& operator=(const MenuScrollTask&) = delete;
void Update(const MenuController::MenuPart& part) {
if (!part.is_scroll()) {
StopScrolling();
return;
}
SubmenuView* const new_menu = part.submenu;
CHECK(new_menu);
const bool new_is_up = part.type == MenuPartType::kScrollUp;
if (new_menu == submenu_ && is_scrolling_up_ == new_is_up) {
return;
}
start_scroll_time_ = base::Time::Now();
submenu_ = new_menu;
pixels_per_second_ = submenu_->GetPreferredItemHeight() * 20;
start_y_ = submenu_->GetVisibleBounds().y();
is_scrolling_up_ = new_is_up;
if (!scrolling_timer_.IsRunning()) {
scrolling_timer_.Start(FROM_HERE, base::Hertz(60), this,
&MenuScrollTask::Run);
}
}
void StopScrolling() {
if (scrolling_timer_.IsRunning()) {
scrolling_timer_.Stop();
submenu_ = nullptr;
}
}
// The menu being scrolled. Returns null if not scrolling.
const SubmenuView* submenu() const { return submenu_; }
private:
void Run() {
CHECK(submenu_);
gfx::Rect vis_rect = submenu_->GetVisibleBounds();
const int delta_y =
base::ClampRound((base::Time::Now() - start_scroll_time_).InSecondsF() *
pixels_per_second_);
vis_rect.set_y(is_scrolling_up_
? std::max(0, start_y_ - delta_y)
: std::min(submenu_->height() - vis_rect.height(),
start_y_ + delta_y));
submenu_->ScrollRectToVisible(vis_rect);
}
// SubmenuView being scrolled.
raw_ptr<SubmenuView> submenu_ = nullptr;
// Direction scrolling.
bool is_scrolling_up_ = false;
// Timer to periodically scroll.
base::RepeatingTimer scrolling_timer_;
// Time we started scrolling at.
base::Time start_scroll_time_;
// How many pixels to scroll per second.
int pixels_per_second_;
// Y-coordinate of submenu_view_ when scrolling started.
int start_y_ = 0;
};
// MenuController:SelectByCharDetails ----------------------------------------
struct MenuController::SelectByCharDetails {
SelectByCharDetails() = default;
// Index of the first menu with the specified mnemonic.
std::optional<size_t> first_match;
// If true there are multiple menu items with the same mnemonic.
bool has_multiple = false;
// Index of the selected item; may remain nullopt.
std::optional<size_t> index_of_item;
// If there are multiple matches this is the index of the item after the
// currently selected item whose mnemonic matches. This may remain nullopt
// even though there are matches.
std::optional<size_t> next_match;
};
// MenuController:State ------------------------------------------------------
MenuController::State::State() = default;
MenuController::State::State(const State& other) = default;
MenuController::State::~State() = default;
// MenuController ------------------------------------------------------------
// static
MenuController* MenuController::active_instance_ = nullptr;
// static
MenuController* MenuController::GetActiveInstance() {
return active_instance_;
}
void MenuController::OnWidgetShowStateChanged(Widget* widget) {
CHECK_EQ(owner_, widget);
// See crbug.com/40914555. Whenever browser widget has show state change close
// all the open menus, unless the widget is not visible, which can happen in
// menu creation tests, which in turn results in menu gets canceled
// immediately.
if (widget->IsVisible()) {
Cancel(ExitType::kAll);
}
}
void MenuController::Run(Widget* parent,
MenuButtonController* button_controller,
MenuItemView* root,
const gfx::Rect& anchor_bounds,
MenuAnchorPosition position,
ui::mojom::MenuSourceType source_type,
MenuType menu_type,
bool is_nested_drag,
gfx::NativeView native_view_for_gestures) {
exit_type_ = ExitType::kNone;
possible_drag_ = false;
drag_in_progress_ = false;
closing_event_time_ = base::TimeTicks();
menu_start_time_ = base::TimeTicks::Now();
// In some cases, the context menu is asynchronously created after the "mouse
// pressed event" is dispatched, so `RootView::current_event()` below is null.
// The mouse press location must be taken from the `anchor_bounds` for these
// cases.
menu_start_mouse_press_loc_ = source_type == ui::mojom::MenuSourceType::kMouse
? anchor_bounds.origin()
: gfx::Point();
ui::Event* event = nullptr;
bool direction_is_down = true;
MenuItemView* to_select = nullptr;
if (parent) {
View* root_view = parent->GetRootView();
if (root_view) {
event = static_cast<internal::RootView*>(root_view)->current_event();
bool is_key_event = event && event->IsKeyEvent();
if (event && event->type() == ui::EventType::kMousePressed) {
menu_start_mouse_press_loc_ = View::ConvertPointToScreen(
static_cast<View*>(event->target()),
static_cast<const ui::MouseEvent*>(event)->location());
} else if constexpr (views::PlatformStyle::
kAutoSelectFirstMenuItemFromKeyboard) {
if (!IsEditableCombobox() &&
(source_type == ui::mojom::MenuSourceType::kKeyboard ||
is_key_event)) {
// On Windows, we want to select the first menu item when the menu is
// opened via keyboard. This is because NVDA expects the focus to be
// on a menu item when the menu is opened via keyboard.
direction_is_down =
!(is_key_event && event->AsKeyEvent()->key_code() == ui::VKEY_UP);
to_select = FindInitialSelectableMenuItem(
root, direction_is_down ? INCREMENT_SELECTION_DOWN
: INCREMENT_SELECTION_UP);
}
}
}
}
// If we are already showing, this new menu is being nested. Such as context
// menus on top of normal menus.
if (showing_) {
// Nesting (context menus) is not used for drag and drop.
DCHECK(!for_drop_);
state_.hot_button = hot_button_;
hot_button_ = nullptr;
// We're already showing, push the current state.
menu_stack_.emplace_back(state_, std::move(pressed_lock_));
// The context menu should be owned by the same parent.
DCHECK_EQ(owner_, parent);
} else {
showing_ = true;
if (owner_) {
owner_->RemoveObserver(this);
}
owner_ = parent;
if (owner_) {
owner_->AddObserver(this);
}
native_view_for_gestures_ = native_view_for_gestures;
// Only create a MenuPreTargetHandler for non-nested menus. Nested menus
// will use the existing one.
menu_pre_target_handler_ = MenuPreTargetHandler::Create(this, owner_);
}
#if BUILDFLAG(IS_MAC)
menu_cocoa_watcher_ = std::make_unique<MenuCocoaWatcherMac>(base::BindOnce(
&MenuController::Cancel, this->AsWeakPtr(), ExitType::kAll));
#endif
// Reset current state.
pending_state_ = State();
state_ = State();
UpdateInitialLocation(anchor_bounds, position, menu_type);
if (views::PlatformStyle::kAutoSelectFirstMenuItemFromKeyboard && to_select) {
// If menu is opened via keyboard, set focus on first selectable menu item,
// but don't open the submenu automatically to maintain the behavior a
// down arrow would have (focusing a menu item from the keyboard doesn't
// open the submenu).
SetSelection(to_select, SELECTION_UPDATE_IMMEDIATELY);
// If the first menu item is a container, we want to select the first button
// inside it as well.
if (!to_select->children().empty() && to_select->IsContainer()) {
Button* hot_button = Button::AsButton(
GetInitialFocusableView(to_select, direction_is_down));
if (hot_button) {
SetHotTrackedButton(hot_button);
}
}
// This prevents the selection set above from overridden by simulated mouse
// events fired upon opening the menu. See `MenuController::OnMouseMoved`
// for more details.
menu_open_mouse_loc_ =
ConvertFromScreen(*to_select->GetRootMenuItem()->GetSubmenu(),
display::Screen::Get()->GetCursorScreenPoint());
} else {
// Set the selection, which opens the initial menu.
SetSelection(root, SELECTION_OPEN_SUBMENU | SELECTION_UPDATE_IMMEDIATELY);
}
if (button_controller) {
pressed_lock_ = button_controller->TakeLock(
false, ui::LocatedEvent::FromIfValid(event));
}
if (for_drop_) {
if (!is_nested_drag) {
// Start the timer to hide the menu. This is needed as we get no
// notification when the drag has finished.
StartCancelAllTimer();
}
return;
}
// Make sure Chrome doesn't attempt to shut down while the menu is showing.
ViewsDelegate::GetInstance()->AddRef();
}
void MenuController::Cancel(ExitType type) {
#if BUILDFLAG(IS_MAC)
menu_closure_animation_.reset();
#endif
// If the menu has already been destroyed, no further cancellation is
// needed. We especially don't want to set the |exit_type_| to a lesser
// value.
if (exit_type_ == ExitType::kDestroyed || exit_type_ == type) {
return;
}
if (!showing_) {
// This occurs if we're in the process of notifying the delegate for a drop
// and the delegate cancels us. Or if the releasing of ViewsDelegate causes
// an immediate shutdown.
return;
}
MenuItemView* selected = state_.item;
SetExitType(type);
SendMouseCaptureLostToActiveView();
// Hide windows immediately.
SetSelection(nullptr, SELECTION_UPDATE_IMMEDIATELY | SELECTION_EXIT);
if (for_drop_) {
// If we didn't block the caller we need to notify the menu, which
// triggers deleting us.
DCHECK(selected);
showing_ = false;
delegate_->OnMenuClosed(internal::MenuControllerDelegate::NOTIFY_DELEGATE,
selected->GetRootMenuItem(), accept_event_flags_);
// WARNING: the call to MenuClosed deletes us.
return;
}
// If |type| is ExitType::kAll we update the state of the menu to not showing.
// For dragging this ensures that the correct visual state is reported until
// the drag operation completes. For non-dragging cases it is possible that
// the release of ViewsDelegate leads immediately to shutdown, which can
// trigger nested calls to Cancel. We want to reject these to prevent
// attempting a nested tear down of this and |delegate_|.
if (type == ExitType::kAll) {
showing_ = false;
}
// On Windows and Linux the destruction of this menu's Widget leads to the
// teardown of the platform specific drag-and-drop Widget. Do not shutdown
// while dragging, leave the Widget hidden until drag-and-drop has completed,
// at which point all menus will be destroyed.
if (!drag_in_progress_) {
ExitMenu();
}
}
void MenuController::AddNestedDelegate(
internal::MenuControllerDelegate* delegate) {
delegate_stack_.push_back(delegate);
delegate_ = delegate;
}
bool MenuController::IsCombobox() const {
return IsEditableCombobox() || IsReadonlyCombobox();
}
bool MenuController::IsEditableCombobox() const {
return combobox_type_ == ComboboxType::kEditable;
}
bool MenuController::IsReadonlyCombobox() const {
return combobox_type_ == ComboboxType::kReadonly;
}
bool MenuController::IsContextMenu() const {
return state_.menu_type == MenuType::kContextMenu ||
state_.menu_type == MenuType::kMenuItemContextMenu;
}
void MenuController::SelectItemAndOpenSubmenu(MenuItemView* item) {
DCHECK(item);
SetSelection(item, SELECTION_OPEN_SUBMENU | SELECTION_UPDATE_IMMEDIATELY);
// If `item` has not a submenu, hot track `item`'s initial focusable button
// if any.
if (!item->HasSubmenu()) {
View* hot_view = GetInitialFocusableView(item, /*forward=*/true);
SetHotTrackedButton(Button::AsButton(hot_view));
}
}
bool MenuController::OnMousePressed(SubmenuView* source,
const ui::MouseEvent& event) {
// We should either have no current_mouse_event_target_, or should have a
// pressed state stored.
DCHECK(!current_mouse_event_target_ || current_mouse_pressed_state_);
// Find the root view to check. If any buttons were previously pressed, this
// is the same root view we've been forwarding to. Otherwise, it's the root
// view of the target.
MenuHostRootView* forward_to_root =
current_mouse_pressed_state_ ? current_mouse_event_target_.get()
: GetRootView(source, event.location());
current_mouse_pressed_state_ |= event.changed_button_flags();
if (forward_to_root) {
// Reset hot-tracking if a different view is getting a mouse press.
const ui::MouseEvent event_for_root =
ConvertLocatedEventForRootView(*source, *forward_to_root, event);
View* view =
forward_to_root->GetEventHandlerForPoint(event_for_root.location());
Button* button = Button::AsButton(view);
if (hot_button_ != button) {
SetHotTrackedButton(button);
}
// Empty menu items are always handled by the menu controller.
if (!IsViewClass<EmptyMenuMenuItem>(view)) {
base::WeakPtr<MenuController> this_ref = AsWeakPtr();
bool processed = forward_to_root->ProcessMousePressed(event_for_root);
// This object may be destroyed as a result of a mouse press event (some
// item may close the menu).
if (!this_ref) {
return true;
}
// If the event was processed, the root view becomes our current mouse
// handler...
if (processed && !current_mouse_event_target_) {
current_mouse_event_target_ = forward_to_root;
}
// ...and we always return the result of the current handler.
if (current_mouse_event_target_) {
return processed;
}
}
}
// Otherwise, the menu handles this click directly.
SetSelectionOnPointerDown(source, &event);
return true;
}
bool MenuController::OnMouseDragged(SubmenuView* source,
const ui::MouseEvent& event) {
if (current_mouse_event_target_) {
return current_mouse_event_target_->ProcessMouseDragged(
ConvertLocatedEventForRootView(*source, *current_mouse_event_target_,
event));
}
MenuPart part = GetMenuPart(source, event.location());
UpdateScrolling(part);
if (for_drop_) {
return false;
}
if (possible_drag_) {
if (View::ExceededDragThreshold(event.location() - press_pt_)) {
StartDrag(source, press_pt_);
}
return true;
}
MenuItemView* mouse_menu = nullptr;
if (part.type == MenuPartType::kMenuItem) {
// If there is no menu target, but a submenu target, then we are interacting
// with an empty menu item within a submenu. These cannot become selection
// targets for mouse interaction, so do not attempt to update selection.
if (part.menu || !part.submenu) {
if (!part.menu) {
part.menu = source->GetMenuItem();
} else {
mouse_menu = part.menu;
}
SetSelection(part.menu ? part.menu.get() : state_.item.get(),
SELECTION_OPEN_SUBMENU);
}
} else if (part.type == MenuPartType::kNone) {
// If there is a sibling menu, show it. Otherwise, if the user has selected
// a menu item with no accompanying sibling menu or submenu, move selection
// back to the parent menu item.
if (!ShowSiblingMenu(source, event.location())) {
if (!part.is_scroll() && pending_state_.item &&
pending_state_.item->GetParentMenuItem() &&
!pending_state_.item->SubmenuIsShowing()) {
SetSelection(pending_state_.item->GetParentMenuItem(),
SELECTION_OPEN_SUBMENU);
}
}
}
UpdateActiveMouseView(source, event, mouse_menu);
return true;
}
void MenuController::OnMouseReleased(SubmenuView* source,
const ui::MouseEvent& event) {
current_mouse_pressed_state_ &= ~event.changed_button_flags();
if (current_mouse_event_target_) {
// If this was the final mouse button, then remove the forwarding target.
// We need to do this *before* dispatching the event to the root view
// because there's a chance that the event will open a nested (and blocking)
// menu, and we need to not have a forwarded root view.
MenuHostRootView* cached_event_target = current_mouse_event_target_;
if (!current_mouse_pressed_state_) {
current_mouse_event_target_ = nullptr;
}
cached_event_target->ProcessMouseReleased(
ConvertLocatedEventForRootView(*source, *cached_event_target, event));
return;
}
// The menu should ignore mouse release events and refrain from closing if a
// drag operation is in progress or has been recently canceled without
// immediate notification.
if (drag_in_progress_ || for_drop_) {
return;
}
DCHECK(state_.item);
possible_drag_ = false;
MenuPart part = GetMenuPart(source, event.location());
if (event.IsRightMouseButton() && part.type == MenuPartType::kMenuItem) {
MenuItemView* menu = part.menu;
// |menu| is null means this event is from an empty menu or a separator.
// If it is from an empty menu, use parent context menu instead of that.
if (!menu && part.submenu->children().size() == 1 &&
IsViewClass<EmptyMenuMenuItem>(part.submenu->children().front())) {
menu = part.parent;
}
if (menu) {
if (ShowContextMenu(menu, ConvertToScreen(*source, event.location()),
ui::mojom::MenuSourceType::kMouse)) {
return;
}
}
}
if (!part.is_scroll() && part.menu &&
part.menu->GetDelegate()->IsTriggerableEvent(part.menu, event)) {
if (active_mouse_view_tracker_->view()) {
SendMouseReleaseToActiveView(source, event);
return;
}
// If a mouse release was received quickly after showing.
base::TimeDelta time_shown = base::TimeTicks::Now() - menu_start_time_;
if (time_shown < menu_selection_hold_time) {
// And it wasn't far from the mouse press location.
const gfx::Vector2d moved = ConvertToScreen(*source, event.location()) -
menu_start_mouse_press_loc_;
if (moved.Length() < kMaximumLengthMovedToActivate) {
// Ignore the mouse release as it was likely this menu was shown under
// the mouse and the action was just a normal click.
return;
}
}
const int command = part.menu->GetCommand();
if (part.menu->GetDelegate()->ShouldExecuteCommandWithoutClosingMenu(
command, event)) {
part.menu->GetDelegate()->ExecuteCommand(command, event.flags());
return;
}
if ((!part.menu->NonIconChildViewsCount() ||
part.menu->GetTriggerActionWithNonIconChildViews()) &&
part.menu->GetDelegate()->IsTriggerableEvent(part.menu, event)) {
Accept(part.menu, event.flags());
return;
}
} else if (part.type == MenuPartType::kMenuItem) {
// User either clicked on empty space, or a menu that has children.
SetSelection(part.menu ? part.menu.get() : state_.item.get(),
SELECTION_OPEN_SUBMENU | SELECTION_UPDATE_IMMEDIATELY);
}
SendMouseCaptureLostToActiveView();
MaybeForwardToAnnotation(source, event);
}
void MenuController::OnMouseMoved(SubmenuView* source,
const ui::MouseEvent& event) {
if (current_mouse_event_target_) {
current_mouse_event_target_->ProcessMouseMoved(
ConvertLocatedEventForRootView(*source, *current_mouse_event_target_,
event));
return;
}
// Opening a submenu can trigger mouse move events at the current mouse
// position (e.g. due to Aura synthesizing them on window visibility changes).
// Ignore these. This ensures submenus opened with the keyboard don't
// incorrectly show a mouse selection before the mouse moves.
if (menu_open_mouse_loc_ &&
*menu_open_mouse_loc_ ==
GetLocationInRootMenu(*source, event.location())) {
return;
}
menu_open_mouse_loc_.reset();
MenuHostRootView* root_view = GetRootView(source, event.location());
Button* new_hot_tracked_button = nullptr;
if (root_view) {
root_view->ProcessMouseMoved(event);
// Update hot-tracked button when a button state is changed with a mouse
// event. It is necessary to track it for accurate hot-tracking when both
// mouse and keyboard are used to navigate the menu.
View* view = root_view->GetEventHandlerForPoint(
ConvertLocatedEventForRootView(*source, *root_view, event).location());
new_hot_tracked_button = Button::AsButton(view);
}
HandleMouseLocation(source, event.location());
// Updating the hot tracked button should be after `HandleMouseLocation()`
// which may reset the current hot tracked button.
if (new_hot_tracked_button) {
SetHotTrackedButton(new_hot_tracked_button);
}
MaybeForwardToAnnotation(source, event);
}
void MenuController::OnMouseEntered(SubmenuView* source,
const ui::MouseEvent& event) {
// MouseEntered is always followed by a mouse moved, so don't need to
// do anything here.
}
bool MenuController::OnMouseWheel(SubmenuView* source,
const ui::MouseWheelEvent& event) {
// Stop scrolling via scroll button to prevent flickering.
StopScrollingViaButton();
MenuPart part = GetMenuPart(source, event.location());
SetSelection(part.menu ? part.menu.get() : state_.item.get(),
SELECTION_OPEN_SUBMENU | SELECTION_UPDATE_IMMEDIATELY);
return part.submenu && part.submenu->OnMouseWheel(event);
}
void MenuController::OnGestureEvent(SubmenuView* source,
ui::GestureEvent* event) {
if (owner_ && send_gesture_events_to_owner()) {
#if defined(USE_AURA)
gfx::NativeView target = native_view_for_gestures_
? native_view_for_gestures_
: owner()->GetNativeWindow();
event->ConvertLocationToTarget(source->GetWidget()->GetNativeWindow(),
target);
target->delegate()->OnGestureEvent(event);
#else
owner()->OnGestureEvent(event);
#endif // defined(USE_AURA)
// Reset |send_gesture_events_to_owner_| when the first gesture ends.
if (event->type() == ui::EventType::kGestureEnd) {
send_gesture_events_to_owner_ = false;
}
return;
}
MenuHostRootView* root_view = GetRootView(source, event->location());
if (root_view) {
// Reset hot-tracking if a different view is getting a touch event.
View* view = root_view->GetEventHandlerForPoint(
ConvertLocatedEventForRootView(*source, *root_view, *event).location());
Button* button = Button::AsButton(view);
if (hot_button_ && hot_button_ != button) {
SetHotTrackedButton(nullptr);
}
}
MenuPart part = GetMenuPart(source, event->location());
if (event->type() == ui::EventType::kGestureTapDown) {
SetSelectionOnPointerDown(source, event);
event->StopPropagation();
} else if (event->type() == ui::EventType::kGestureLongPress) {
if (part.type == MenuPartType::kMenuItem && part.menu) {
if (ShowContextMenu(part.menu,
ConvertToScreen(*source, event->location()),
ui::mojom::MenuSourceType::kTouch)) {
event->StopPropagation();
}
}
} else if (event->type() == ui::EventType::kGestureTap) {
if (!part.is_scroll() && part.menu &&
!(part.should_submenu_show && part.menu->HasSubmenu())) {
const int command = part.menu->GetCommand();
if (part.menu->GetDelegate()->ShouldExecuteCommandWithoutClosingMenu(
command, *event)) {
item_selected_by_touch_ = true;
part.menu->GetDelegate()->ExecuteCommand(command, 0);
} else if (part.menu->GetDelegate()->IsTriggerableEvent(part.menu,
*event)) {
item_selected_by_touch_ = true;
Accept(part.menu, event->flags());
}
event->StopPropagation();
} else if (part.type == MenuPartType::kMenuItem) {
// User either tapped on empty space, or a menu that has children.
SetSelection(part.menu ? part.menu.get() : state_.item.get(),
SELECTION_OPEN_SUBMENU | SELECTION_UPDATE_IMMEDIATELY);
event->StopPropagation();
}
} else if (event->type() == ui::EventType::kGestureTapCancel && part.menu &&
part.type == MenuPartType::kMenuItem) {
// Move the selection to the parent menu so that the selection in the
// current menu is unset. Make sure the submenu remains open by sending the
// appropriate SetSelectionTypes flags.
SetSelection(part.menu->GetParentMenuItem(),
SELECTION_OPEN_SUBMENU | SELECTION_UPDATE_IMMEDIATELY);
event->StopPropagation();
}
if (event->stopped_propagation()) {
return;
}
if (!part.submenu) {
return;
}
part.submenu->OnGestureEvent(event);
}
void MenuController::OnTouchEvent(SubmenuView* source, ui::TouchEvent* event) {
// Bail if owner wants the current active gesture sequence.
if (owner_ && send_gesture_events_to_owner()) {
return;
}
if (event->type() == ui::EventType::kTouchPressed) {
MenuPart part = GetMenuPart(source, event->location());
if (part.type == MenuPartType::kNone) {
if (MaybeForwardToAnnotation(source, *event)) {
event->SetHandled();
return;
}
RepostEventAndCancel(source, event);
event->SetHandled();
}
} else {
MaybeForwardToAnnotation(source, *event);
}
}
View* MenuController::GetTooltipHandlerForPoint(SubmenuView* source,
const gfx::Point& point) {
MenuHostRootView* root_view = GetRootView(source, point);
return root_view ? root_view->ProcessGetTooltipHandlerForPoint(point)
: nullptr;
}
void MenuController::ViewHierarchyChanged(
SubmenuView* source,
const ViewHierarchyChangedDetails& details) {
if (!details.is_add) {
// If the current mouse handler is removed, remove it as the handler.
if (details.child == current_mouse_event_target_) {
current_mouse_event_target_ = nullptr;
current_mouse_pressed_state_ = 0;
}
// Update |hot_button_| (both in |this| and in |menu_stack_| if it gets
// removed while a menu is up.
if (details.child == hot_button_) {
hot_button_ = nullptr;
for (auto& nested_state : menu_stack_) {
State& state = nested_state.first;
if (details.child == state.hot_button) {
state.hot_button = nullptr;
}
}
}
}
}
bool MenuController::GetDropFormats(
SubmenuView* source,
int* formats,
std::set<ui::ClipboardFormatType>* format_types) {
return source->GetMenuItem()->GetDelegate()->GetDropFormats(
source->GetMenuItem(), formats, format_types);
}
bool MenuController::AreDropTypesRequired(SubmenuView* source) {
return source->GetMenuItem()->GetDelegate()->AreDropTypesRequired(
source->GetMenuItem());
}
bool MenuController::CanDrop(SubmenuView* source, const OSExchangeData& data) {
return source->GetMenuItem()->GetDelegate()->CanDrop(source->GetMenuItem(),
data);
}
void MenuController::OnDragEntered(SubmenuView* source,
const ui::DropTargetEvent& event) {
valid_drop_coordinates_ = false;
}
int MenuController::OnDragUpdated(SubmenuView* source,
const ui::DropTargetEvent& event) {
StopCancelAllTimer();
const gfx::Point screen_loc =
View::ConvertPointToScreen(source, event.location());
if (valid_drop_coordinates_ && screen_loc == drop_pt_) {
return last_drop_operation_;
}
drop_pt_ = screen_loc;
valid_drop_coordinates_ = true;
MenuItemView* menu_item = GetMenuItemAt(source, event.location());
bool over_empty_menu = false;
if (!menu_item) {
// See if we're over an empty menu. `GetMenuItemAt` fails in this case
// because it uses `GetEventHandlerForPoint`, which requires an enabled
// `View`, while `EmptyMenuMenuItem`s are disabled.
// `GetTooltipHandlerForPoint` does not have this restriction.
menu_item = AsViewClass<EmptyMenuMenuItem>(
source->GetTooltipHandlerForPoint(event.location()));
if (menu_item) {
over_empty_menu = true;
}
}
MenuDelegate::DropPosition drop_position = MenuDelegate::DropPosition::kNone;
int drop_operation = ui::DragDropTypes::DRAG_NONE;
if (menu_item) {
gfx::Point menu_item_loc(event.location());
View::ConvertPointToTarget(source, menu_item, &menu_item_loc);
MenuItemView* query_menu_item;
if (!over_empty_menu) {
int menu_item_height = menu_item->height();
if (menu_item->HasSubmenu() &&
(menu_item_loc.y() > kDropBetweenPixels &&
menu_item_loc.y() < (menu_item_height - kDropBetweenPixels))) {
drop_position = MenuDelegate::DropPosition::kOn;
} else {
drop_position = (menu_item_loc.y() < menu_item_height / 2)
? MenuDelegate::DropPosition::kBefore
: MenuDelegate::DropPosition::kAfter;
}
query_menu_item = menu_item;
} else {
query_menu_item = menu_item->GetParentMenuItem();
drop_position = MenuDelegate::DropPosition::kOn;
}
drop_operation =
static_cast<int>(menu_item->GetDelegate()->GetDropOperation(
query_menu_item, event, &drop_position));
// If the menu has a submenu, schedule the submenu to open.
SetSelection(menu_item, menu_item->HasSubmenu() ? SELECTION_OPEN_SUBMENU
: SELECTION_DEFAULT);
if (drop_position == MenuDelegate::DropPosition::kNone ||
drop_operation == ui::DragDropTypes::DRAG_NONE) {
menu_item = nullptr;
}
} else {
SetSelection(source->GetMenuItem(), SELECTION_OPEN_SUBMENU);
}
SetDropMenuItem(menu_item, drop_position);
last_drop_operation_ = drop_operation;
return drop_operation;
}
void MenuController::OnDragExited(SubmenuView* source) {
StartCancelAllTimer();
if (drop_target_) {
StopShowTimer();
SetDropMenuItem(nullptr, MenuDelegate::DropPosition::kNone);
}
}
views::View::DropCallback MenuController::GetDropCallback(
SubmenuView* source,
const ui::DropTargetEvent& event) {
DCHECK(drop_target_);
MenuItemView* item = state_.item;
DCHECK(item);
// If over an empty menu item, drop occurs on the parent.
if (IsViewClass<EmptyMenuMenuItem>(drop_target_)) {
drop_target_ = drop_target_->GetParentMenuItem();
}
MenuItemView* drop_target = drop_target_;
MenuDelegate::DropPosition drop_position = drop_position_;
if (for_drop_) {
// Close all menus, including any nested menus.
SetSelection(nullptr, SELECTION_UPDATE_IMMEDIATELY | SELECTION_EXIT);
CloseAllNestedMenus();
// Set state such that we exit.
showing_ = false;
SetExitType(ExitType::kAll);
delegate_->OnMenuClosed(
internal::MenuControllerDelegate::DONT_NOTIFY_DELEGATE,
item->GetRootMenuItem(), accept_event_flags_);
}
// WARNING: the call to MenuClosed deletes us.
return drop_target->GetDelegate()->GetDropCallback(drop_target, drop_position,
event);
}
void MenuController::OnDragEnteredScrollButton(SubmenuView* source,
bool is_up) {
MenuPart part;
part.type = is_up ? MenuPartType::kScrollUp : MenuPartType::kScrollDown;
part.submenu = source;
UpdateScrolling(part);
// Do this to force the selection to hide.
SetDropMenuItem(source->GetMenuItemAt(0), MenuDelegate::DropPosition::kNone);
StopCancelAllTimer();
}
void MenuController::OnDragExitedScrollButton(SubmenuView* source) {
StartCancelAllTimer();
SetDropMenuItem(nullptr, MenuDelegate::DropPosition::kNone);
StopScrollingViaButton();
}
void MenuController::OnDragWillStart() {
DCHECK(!drag_in_progress_);
drag_in_progress_ = true;
}
void MenuController::OnDragComplete(bool should_close) {
DCHECK(drag_in_progress_);
drag_in_progress_ = false;
// During a drag, mouse events are processed directly by the widget, and not
// sent to the MenuController. At drag completion, reset pressed state and
// the event target.
current_mouse_pressed_state_ = 0;
current_mouse_event_target_ = nullptr;
possible_drag_ = false;
// TODO(crbug.com/375959961): On X11, the native widget's mouse button state
// is not updated when the mouse button is released to end a drag. Therefore,
// all subsequent mouse movements will be delivered as "MouseDragged" events.
// Until this is fixed, the menu should be closed.
#if BUILDFLAG(IS_OZONE_X11)
should_close = true;
#endif
if (!should_close) {
StopCancelAllTimer();
return;
}
if (showing_) {
// During a drag operation there are several ways in which this can be
// canceled and deleted. Verify that this is still active before closing
// the widgets.
if (GetActiveInstance() == this) {
base::WeakPtr<MenuController> this_ref = AsWeakPtr();
CloseAllNestedMenus();
Cancel(ExitType::kAll);
// The above may have deleted us. If not perform a full shutdown.
if (!this_ref) {
return;
}
ExitMenu();
}
} else if (exit_type_ == ExitType::kAll) {
// We may have been canceled during the drag. If so we still need to fully
// shutdown.
ExitMenu();
}
}
ui::PostDispatchAction MenuController::OnWillDispatchKeyEvent(
ui::KeyEvent* event) {
if (exit_type() == ExitType::kAll || exit_type() == ExitType::kDestroyed) {
// If the event has arrived after the menu's exit type has changed but
// before its Widgets have been destroyed, the event will continue its
// normal propagation for the following reason:
// If the user accepts a menu item in a nested menu, and the menu item
// action starts a base::RunLoop; IDC_BOOKMARK_BAR_OPEN_ALL sometimes opens
// a modal dialog. The modal dialog starts a base::RunLoop and keeps the
// base::RunLoop running for the duration of its lifetime.
return ui::POST_DISPATCH_PERFORM_DEFAULT;
}
base::WeakPtr<MenuController> this_ref = AsWeakPtr();
if (event->type() == ui::EventType::kKeyPressed) {
bool key_handled = false;
#if BUILDFLAG(IS_MAC)
// Special handling for Option-Up and Option-Down, which should behave like
// Home and End respectively in menus.
if ((event->flags() & ui::EF_ALT_DOWN)) {
ui::KeyEvent rewritten_event(*event);
if (event->key_code() == ui::VKEY_UP) {
rewritten_event.set_key_code(ui::VKEY_HOME);
} else if (event->key_code() == ui::VKEY_DOWN) {
rewritten_event.set_key_code(ui::VKEY_END);
}
key_handled = OnKeyPressed(rewritten_event);
} else {
key_handled = OnKeyPressed(*event);
}
#else
key_handled = OnKeyPressed(*event);
#endif
if (key_handled) {
event->StopPropagation();
}
// Key events can lead to this being deleted.
if (!this_ref) {
event->StopPropagation();
return ui::POST_DISPATCH_NONE;
}
if (!IsEditableCombobox() && !event->stopped_propagation()) {
// Do not check mnemonics if the Alt or Ctrl modifiers are pressed. For
// example Ctrl+<T> is an accelerator, but <T> only is a mnemonic.
const int kKeyFlagsMask =
ui::EF_CONTROL_DOWN | ui::EF_ALT_DOWN | ui::EF_COMMAND_DOWN;
const int flags = event->flags();
if (exit_type() == ExitType::kNone && (flags & kKeyFlagsMask) == 0) {
char16_t c = event->GetCharacter();
SelectByChar(c);
// SelectByChar can lead to this being deleted.
if (!this_ref) {
event->StopPropagation();
return ui::POST_DISPATCH_NONE;
}
}
}
}
ui::Accelerator accelerator(*event);
#if BUILDFLAG(IS_MAC)
if (AcceleratorShouldCancelMenu(accelerator)) {
Cancel(ExitType::kAll);
return ui::POST_DISPATCH_PERFORM_DEFAULT;
}
#endif
ViewsDelegate::ProcessMenuAcceleratorResult result =
ViewsDelegate::GetInstance()->ProcessAcceleratorWhileMenuShowing(
accelerator);
// Above can lead to |this| being deleted.
if (!this_ref) {
event->StopPropagation();
return ui::POST_DISPATCH_NONE;
}
if (result == ViewsDelegate::ProcessMenuAcceleratorResult::CLOSE_MENU) {
Cancel(ExitType::kAll);
event->StopPropagation();
return ui::POST_DISPATCH_NONE;
}
if (IsEditableCombobox()) {
const base::flat_set<ui::KeyboardCode> kKeysThatDontPropagate = {
ui::VKEY_DOWN, ui::VKEY_UP, ui::VKEY_ESCAPE, ui::VKEY_F4,
ui::VKEY_RETURN};
if (kKeysThatDontPropagate.find(event->key_code()) ==
kKeysThatDontPropagate.end()) {
return ui::POST_DISPATCH_PERFORM_DEFAULT;
}
}
event->SetSkipped();
return ui::POST_DISPATCH_NONE;
}
void MenuController::UpdateSubmenuSelection(SubmenuView* submenu) {
if (submenu->IsShowing()) {
HandleMouseLocation(
submenu,
ConvertFromScreen(GetRootMenu(*submenu),
display::Screen::Get()->GetCursorScreenPoint()));
}
}
void MenuController::OnWidgetDestroying(Widget* widget) {
DCHECK_EQ(owner_, widget);
owner_->RemoveObserver(this);
owner_ = nullptr;
native_view_for_gestures_ = gfx::NativeView();
#if BUILDFLAG(IS_MAC)
menu_closure_animation_.reset();
#endif
// Exit menu to ensure that we are not holding on to resources when the
// widget has been destroyed.
ExitMenu();
}
bool MenuController::IsCancelAllTimerRunningForTest() {
return cancel_all_timer_.IsRunning();
}
void MenuController::ClearStateForTest() {
state_ = State();
pending_state_ = State();
}
// static
void MenuController::TurnOffMenuSelectionHoldForTest() {
menu_selection_hold_time = base::TimeDelta();
}
ui::ColorId MenuController::GetSeparatorColorId() const {
#if BUILDFLAG(IS_CHROMEOS)
if (use_ash_system_ui_layout_) {
return ui::kColorAshSystemUIMenuSeparator;
}
#endif
return ui::kColorMenuSeparator;
}
void MenuController::OnMenuItemDestroying(MenuItemView* menu_item) {
#if BUILDFLAG(IS_MAC)
if (menu_closure_animation_ && menu_closure_animation_->item() == menu_item) {
menu_closure_animation_.reset();
}
#endif
UnregisterAlertedItem(menu_item);
bool found_in_pending_state = false;
bool found_in_current_state = false;
int menu_stack_matches = 0;
if (pending_state_.item == menu_item) {
pending_state_.item = nullptr;
found_in_pending_state = true;
}
if (state_.item == menu_item) {
state_.item = nullptr;
found_in_current_state = true;
}
for (auto& menu_state_pair : menu_stack_) {
if (menu_state_pair.first.item == menu_item) {
menu_state_pair.first.item = nullptr;
menu_stack_matches++;
}
}
if (found_in_pending_state || found_in_current_state ||
menu_stack_matches > 0) {
// This indicates a lifecycle management issue - MenuItemView destroyed
// while still referenced by MenuController.
// Remove this DumpWithoutCrashing once we get enough information.
base::debug::DumpWithoutCrashing();
}
}
void MenuController::AnimationProgressed(const gfx::Animation* animation) {
DCHECK_EQ(animation, &alert_animation_);
// Schedule paints at each alerted menu item. The menu items pull the
// animation's current value in their OnPaint methods.
for (MenuItemView* item : alerted_items_) {
if (item->GetParentMenuItem()->SubmenuIsShowing()) {
item->SchedulePaint();
}
}
}
void MenuController::SetSelection(MenuItemView* menu_item,
int selection_types) {
size_t paths_differ_at = 0;
std::vector<MenuItemView*> current_path;
std::vector<MenuItemView*> new_path;
BuildPathsAndCalculateDiff(pending_state_.item, menu_item, &current_path,
&new_path, &paths_differ_at);
size_t current_size = current_path.size();
size_t new_size = new_path.size();
// ACTIONABLE_SUBMENUs can change without changing the pending item, this
// occurs when selection moves from the COMMAND area to the SUBMENU area of
// the ACTIONABLE_SUBMENU.
const bool pending_item_changed =
pending_state_.item != menu_item ||
pending_state_.submenu_open !=
!!(selection_types & SELECTION_OPEN_SUBMENU);
if (pending_item_changed && pending_state_.item) {
SetHotTrackedButton(nullptr);
}
auto this_ref = AsWeakPtr();
// Notify an accessibility focus event on all menu items except for the root.
bool ensure_focus_within_popup =
menu_item && pending_item_changed &&
(MenuDepth(menu_item) != 1 ||
menu_item->GetType() != MenuItemView::Type::kSubMenu ||
(menu_item->GetType() == MenuItemView::Type::kActionableSubMenu &&
(selection_types & SELECTION_OPEN_SUBMENU) == 0));
if (ensure_focus_within_popup) {
// The selection event is now fired when the selected state is set on the
// accessibility cache when the MenuItem is selected. Before firing the
// selection event, ensure that focus appears to be within the popup. This
// is helpful for ATs on some platforms, specifically on Windows, where
// selection events in a list are mapped to focus events. Without this call,
// the focus appears to be elsewhere.
menu_item->GetViewAccessibility().SetPopupFocusOverride();
}
// Possible fix for https:://crbug.com/443019015, in case menu_controller is
// getting deleted as a side effect of accessibility code above. The crash
// happens when accessibility has been turned on around the same time as
// opening the menu.
if (!this_ref) {
return;
}
// Notify the old path it isn't selected.
MenuDelegate* current_delegate =
current_path.empty() ? nullptr : current_path.front()->GetDelegate();
for (size_t i = paths_differ_at; i < current_size; ++i) {
if (current_delegate &&
(current_path[i]->GetType() == MenuItemView::Type::kSubMenu ||
current_path[i]->GetType() ==
MenuItemView::Type::kActionableSubMenu)) {
current_delegate->WillHideMenu(current_path[i]);
}
current_path[i]->SetSelected(false);
}
// Notify the new path it is selected.
for (size_t i = paths_differ_at; i < new_size; ++i) {
new_path[i]->ScrollRectToVisible(new_path[i]->GetLocalBounds());
new_path[i]->SetSelected(true);
if (new_path[i]->GetType() == MenuItemView::Type::kActionableSubMenu) {
new_path[i]->SetSelectionOfActionableSubmenu(
(selection_types & SELECTION_OPEN_SUBMENU) != 0);
}
}
if (menu_item &&
menu_item->GetType() == MenuItemView::Type::kActionableSubMenu) {
menu_item->SetSelectionOfActionableSubmenu(
(selection_types & SELECTION_OPEN_SUBMENU) != 0);
}
DCHECK(menu_item || (selection_types & SELECTION_EXIT) != 0);
pending_state_.item = menu_item;
pending_state_.submenu_open = (selection_types & SELECTION_OPEN_SUBMENU) != 0;
// Stop timers.
StopCancelAllTimer();
// Resets show timer only when pending menu item is changed.
if (pending_item_changed) {
StopShowTimer();
}
if (selection_types & SELECTION_UPDATE_IMMEDIATELY) {
CommitPendingSelection();
} else if (pending_item_changed) {
StartShowTimer();
}
if (ensure_focus_within_popup) {
// Notify an accessibility selected children changed event on the parent
// submenu.
if (menu_item->GetParentMenuItem() &&
menu_item->GetParentMenuItem()->GetSubmenu()) {
menu_item->GetParentMenuItem()
->GetSubmenu()
->NotifyAccessibilityEventDeprecated(
ax::mojom::Event::kSelectedChildrenChanged,
/*send_native_event=*/true);
}
}
}
void MenuController::SetSelectionOnPointerDown(SubmenuView* source,
const ui::LocatedEvent* event) {
if (for_drop_) {
return;
}
DCHECK(!active_mouse_view_tracker_->view());
MenuPart part = GetMenuPart(source, event->location());
if (part.is_scroll()) {
return; // Ignore presses on scroll buttons.
}
// When this menu is opened through a touch event, a simulated right-click
// is sent before the menu appears. Ignore it.
if ((event->flags() & ui::EF_RIGHT_MOUSE_BUTTON) &&
(event->flags() & ui::EF_FROM_TOUCH)) {
return;
}
if (part.type == MenuPartType::kNone ||
(part.type == MenuPartType::kMenuItem && part.menu &&
part.menu->GetRootMenuItem() != state_.item->GetRootMenuItem())) {
// See if this event was located within a menu annotation.
if (MaybeForwardToAnnotation(source, *event)) {
return;
}
// Remember the time stamp of the current (press down) event. The owner can
// then use this to figure out if this menu was finished with the same click
// which is sent to it thereafter.
closing_event_time_ = event->time_stamp();
// Event wasn't pressed over any menu, or the active menu, cancel.
RepostEventAndCancel(source, event);
// Do not repost events for Linux Aura because this behavior is more
// consistent with the behavior of other Linux apps.
return;
}
// On a press we immediately commit the selection, that way a submenu
// pops up immediately rather than after a delay.
int selection_types = SELECTION_UPDATE_IMMEDIATELY;
if (!part.menu) {
part.menu = part.parent;
selection_types |= SELECTION_OPEN_SUBMENU;
} else {
if (part.menu->GetDelegate()->CanDrag(part.menu)) {
possible_drag_ = true;
press_pt_ = event->location();
}
if (part.menu->HasSubmenu() && part.should_submenu_show) {
selection_types |= SELECTION_OPEN_SUBMENU;
}
}
SetSelection(part.menu, selection_types);
}
void MenuController::StartDrag(SubmenuView* source,
const gfx::Point& location) {
MenuItemView* item = state_.item;
DCHECK(item);
// Points are in the coordinates of the submenu, need to map to that of
// the selected item. Additionally source may not be the parent of
// the selected item, so need to map to screen first then to item.
const gfx::Point press_loc =
View::ConvertPointFromScreen(item, ConvertToScreen(*source, location));
gfx::Point widget_loc = press_loc;
View::ConvertPointToWidget(item, &widget_loc);
float raster_scale = ScaleFactorForDragFromWidget(source->GetWidget());
gfx::Canvas canvas(item->size(), raster_scale, false /* opaque */);
item->PaintForDrag(&canvas);
gfx::ImageSkia image =
gfx::ImageSkia::CreateFromBitmap(canvas.GetBitmap(), raster_scale);
std::unique_ptr<OSExchangeData> data(std::make_unique<OSExchangeData>());
item->GetDelegate()->WriteDragData(item, data.get());
data->provider().SetDragImage(image, press_loc.OffsetFromOrigin());
StopScrollingViaButton();
int drag_ops = item->GetDelegate()->GetDragOperations(item);
bool had_capture = source->host()->HasCapture();
base::WeakPtr<MenuController> this_ref = AsWeakPtr();
// TODO(varunjain): Properly determine and send DragEventSource below.
item->GetWidget()->RunShellDrag(nullptr, std::move(data), widget_loc,
drag_ops, ui::mojom::DragEventSource::kMouse);
if (!this_ref) {
return;
}
if (showing_ && had_capture) {
// We don't need to add a view as the delegate because the MenuHost widget
// will forward mouse events to the MenuController through the root view.
source->host()->SetCapture(nullptr);
}
}
bool MenuController::OnKeyPressed(const ui::KeyEvent& event) {
DCHECK_EQ(event.type(), ui::EventType::kKeyPressed);
// Do not process while performing drag-and-drop.
if (for_drop_) {
return false;
}
bool handled_key_code = false;
const ui::KeyboardCode key_code = event.key_code();
switch (key_code) {
case ui::VKEY_HOME:
if (IsEditableCombobox()) {
break;
}
MoveSelectionToFirstOrLastItem(INCREMENT_SELECTION_DOWN);
break;
case ui::VKEY_END:
if (IsEditableCombobox()) {
break;
}
MoveSelectionToFirstOrLastItem(INCREMENT_SELECTION_UP);
break;
case ui::VKEY_UP:
case ui::VKEY_PRIOR:
IncrementSelection(INCREMENT_SELECTION_UP);
break;
case ui::VKEY_DOWN:
case ui::VKEY_NEXT:
IncrementSelection(INCREMENT_SELECTION_DOWN);
break;
// Handling of VK_RIGHT and VK_LEFT is different depending on the UI
// layout.
case ui::VKEY_RIGHT:
if (IsEditableCombobox()) {
break;
}
if (base::i18n::IsRTL()) {
CloseSubmenu();
} else {
OpenSubmenuChangeSelectionIfCan();
}
break;
case ui::VKEY_LEFT:
if (IsEditableCombobox()) {
break;
}
if (base::i18n::IsRTL()) {
OpenSubmenuChangeSelectionIfCan();
} else {
CloseSubmenu();
}
break;
// On Mac, treat space the same as return.
#if !BUILDFLAG(IS_MAC)
case ui::VKEY_SPACE:
SendAcceleratorToHotTrackedView(event.flags());
break;
#endif
case ui::VKEY_F4:
if (!IsCombobox()) {
break;
}
// Fallthrough to accept or dismiss combobox menus on F4, like windows.
[[fallthrough]];
case ui::VKEY_RETURN:
#if BUILDFLAG(IS_MAC)
case ui::VKEY_SPACE:
#endif
// An odd special case: if a prefix selection is in flight, space should
// add to that selection rather than activating the menu. This is
// important for allowing the user to select between items that have the
// same first word.
if (key_code == ui::VKEY_SPACE &&
MenuConfig::instance().all_menus_use_prefix_selection &&
ShouldContinuePrefixSelection()) {
break;
}
if (pending_state_.item) {
if (pending_state_.item->HasSubmenu()) {
if ((key_code == ui::VKEY_F4 ||
(key_code == ui::VKEY_RETURN && IsEditableCombobox())) &&
pending_state_.item->GetSubmenu()->IsShowing()) {
Cancel(ExitType::kAll);
} else {
OpenSubmenuChangeSelectionIfCan();
}
} else {
handled_key_code = true;
if (!SendAcceleratorToHotTrackedView(event.flags()) &&
pending_state_.item->GetEnabled()) {
const int command = pending_state_.item->GetCommand();
if (pending_state_.item->GetDelegate()
->ShouldExecuteCommandWithoutClosingMenu(command, event)) {
pending_state_.item->GetDelegate()->ExecuteCommand(command, 0);
} else {
Accept(pending_state_.item, event.flags());
}
}
}
}
break;
case ui::VKEY_ESCAPE:
if (!state_.item->GetParentMenuItem() ||
(!state_.item->GetParentMenuItem()->GetParentMenuItem() &&
(!state_.item->SubmenuIsShowing()))) {
// User pressed escape and current menu has no submenus. If we are
// nested, close the current menu on the stack. Otherwise fully exit the
// menu.
Cancel(delegate_stack_.size() > 1 ? ExitType::kOutermost
: ExitType::kAll);
break;
}
CloseSubmenu();
break;
#if !BUILDFLAG(IS_MAC)
case ui::VKEY_APPS: {
Button* hot_view = GetFirstHotTrackedView(pending_state_.item);
if (hot_view) {
hot_view->ShowContextMenu(hot_view->GetKeyboardContextMenuLocation(),
ui::mojom::MenuSourceType::kKeyboard);
} else if (pending_state_.item->GetEnabled() &&
pending_state_.item->GetRootMenuItem() !=
pending_state_.item) {
// Show the context menu for the given menu item. We don't try to show
// the menu for the (boundless) root menu item. This can happen, e.g.,
// when the user hits the APPS key after opening the menu, when no item
// is selected, but showing a context menu for an implicitly-selected
// and invisible item doesn't make sense.
ShowContextMenu(pending_state_.item,
pending_state_.item->GetKeyboardContextMenuLocation(),
ui::mojom::MenuSourceType::kKeyboard);
}
break;
}
#endif
#if BUILDFLAG(IS_WIN)
// On Windows, pressing Alt and F10 keys should hide the menu to match the
// OS behavior.
case ui::VKEY_MENU:
case ui::VKEY_F10:
Cancel(ExitType::kAll);
break;
#endif
default:
break;
}
return handled_key_code;
}
MenuController::MenuController(bool for_drop,
internal::MenuControllerDelegate* delegate)
: for_drop_(for_drop),
result_(nullptr),
drop_target_(nullptr),
active_mouse_view_tracker_(std::make_unique<ViewTracker>()),
delegate_(delegate),
alert_animation_(this) {
delegate_stack_.push_back(delegate_.get());
active_instance_ = this;
}
MenuController::~MenuController() {
DCHECK(!showing_);
if (owner_) {
owner_->RemoveObserver(this);
}
if (active_instance_ == this) {
active_instance_ = nullptr;
}
StopShowTimer();
StopCancelAllTimer();
CHECK(!IsInObserverList());
}
bool MenuController::SendAcceleratorToHotTrackedView(int event_flags) {
Button* hot_view = GetFirstHotTrackedView(pending_state_.item);
if (!hot_view) {
return false;
}
base::WeakPtr<MenuController> this_ref = AsWeakPtr();
ui::Accelerator accelerator(ui::VKEY_RETURN, event_flags);
hot_view->AcceleratorPressed(accelerator);
// An accelerator may have canceled the menu after activation.
if (this_ref) {
Button* button = static_cast<Button*>(hot_view);
SetHotTrackedButton(button);
}
return true;
}
void MenuController::UpdateInitialLocation(const gfx::Rect& anchor_bounds,
MenuAnchorPosition position,
MenuType menu_type) {
pending_state_.menu_type = menu_type;
pending_state_.initial_bounds = anchor_bounds;
pending_state_.anchor = AdjustAnchorPositionForRtl(position);
// Calculate the bounds of the monitor we'll show menus on. Do this once to
// avoid repeated system queries for the info.
const display::Display display =
display::Screen::Get()->GetDisplayNearestPoint(anchor_bounds.origin());
pending_state_.monitor_bounds = display.work_area();
if (!pending_state_.monitor_bounds.Contains(anchor_bounds)) {
// Use the monitor area if the work area doesn't contain the bounds. This
// handles showing a menu from the launcher.
if (display.bounds().Contains(anchor_bounds)) {
pending_state_.monitor_bounds = display.bounds();
}
}
}
// static
MenuAnchorPosition MenuController::AdjustAnchorPositionForRtl(
MenuAnchorPosition position) {
if (!base::i18n::IsRTL()) {
return position;
}
// Reverse anchor position for RTL languages.
switch (position) {
case MenuAnchorPosition::kTopLeft:
return MenuAnchorPosition::kTopRight;
case MenuAnchorPosition::kTopRight:
return MenuAnchorPosition::kTopLeft;
case MenuAnchorPosition::kBubbleTopLeft:
return MenuAnchorPosition::kBubbleTopRight;
case MenuAnchorPosition::kBubbleTopRight:
return MenuAnchorPosition::kBubbleTopLeft;
case MenuAnchorPosition::kBubbleLeft:
return MenuAnchorPosition::kBubbleRight;
case MenuAnchorPosition::kBubbleRight:
return MenuAnchorPosition::kBubbleLeft;
case MenuAnchorPosition::kBubbleBottomLeft:
return MenuAnchorPosition::kBubbleBottomRight;
case MenuAnchorPosition::kBubbleBottomRight:
return MenuAnchorPosition::kBubbleBottomLeft;
case MenuAnchorPosition::kBottomCenter:
return position;
}
}
void MenuController::Accept(MenuItemView* item, int event_flags) {
// This counts as activation of a menu item. We don't put this logic in
// ReallyAccept() because we expect activation to happen while the element is
// visible to the user, but ReallyAccept() is called on Mac *after* the menu
// is closed.
if (item) {
const ui::ElementIdentifier id = item->GetProperty(kElementIdentifierKey);
if (id) {
views::ElementTrackerViews::GetInstance()->NotifyViewActivated(id, item);
}
}
// EndPopupFocusOverride before closing the menu, the focus should move on
// after closing the menu.
item->GetViewAccessibility().EndPopupFocusOverride();
// Setting `result_` now means that a future Cancel() call will include that
// `result_` in its delegate notification, and thus the clicked command will
// still be executed even if the menu is canceled during the close animation.
// See crbug.com/1251450. Note that we don't set the exit type at this point,
// because we want the Cancel's exit type to take precedence.
result_ = item;
accept_event_flags_ = event_flags;
#if BUILDFLAG(IS_MAC)
menu_closure_animation_ = std::make_unique<MenuClosureAnimationMac>(
item, item->GetParentMenuItem()->GetSubmenu(),
base::BindOnce(&MenuController::ReallyAccept, base::Unretained(this)));
menu_closure_animation_->Start();
#else
ReallyAccept();
#endif
}
void MenuController::ReallyAccept() {
DCHECK(!for_drop_);
#if BUILDFLAG(IS_MAC)
// Reset the closure animation since it's now finished - this also unblocks
// input events for the menu.
menu_closure_animation_.reset();
#endif
if (result_ && !menu_stack_.empty() &&
!result_->GetDelegate()->ShouldCloseAllMenusOnExecute(
result_->GetCommand())) {
SetExitType(ExitType::kOutermost);
} else {
SetExitType(ExitType::kAll);
}
ExitMenu();
}
bool MenuController::ShowSiblingMenu(SubmenuView* source,
const gfx::Point& mouse_location) {
if (!menu_stack_.empty() || !pressed_lock_.get()) {
return false;
}
if (Contains(*source, mouse_location)) {
// The mouse is over the menu, no need to continue.
return false;
}
// TODO(oshima): Replace with views only API.
if (!owner_ ||
!display::Screen::Get()->IsWindowUnderCursor(owner_->GetNativeWindow())) {
return false;
}
// The user moved the mouse outside the menu and over the owning window. See
// if there is a sibling menu we should show.
const gfx::Point screen_point = ConvertToScreen(*source, mouse_location);
MenuAnchorPosition anchor;
bool has_mnemonics;
MenuButton* button = nullptr;
MenuItemView* alt_menu = source->GetMenuItem()->GetDelegate()->GetSiblingMenu(
source->GetMenuItem()->GetRootMenuItem(), screen_point, &anchor,
&has_mnemonics, &button);
if (!alt_menu ||
(state_.item && state_.item->GetRootMenuItem() == alt_menu)) {
return false;
}
delegate_->SiblingMenuCreated(alt_menu);
// If the delegate returns a menu, they must also return a button.
CHECK(button);
// There is a sibling menu, update the button state, hide the current menu
// and show the new one.
pressed_lock_ = button->button_controller()->TakeLock(true, nullptr);
// Need to reset capture when we show the menu again, otherwise we aren't
// going to get any events.
did_capture_ = false;
// It is currently not possible to show a submenu recursively in a bubble.
DCHECK(!MenuItemView::IsBubble(anchor));
UpdateInitialLocation(button->GetBoundsInScreen(), anchor, state_.menu_type);
alt_menu->PrepareForRun(
has_mnemonics, source->GetMenuItem()->GetRootMenuItem()->show_mnemonics_);
alt_menu->controller_ = AsWeakPtr();
SetSelection(alt_menu, SELECTION_OPEN_SUBMENU | SELECTION_UPDATE_IMMEDIATELY);
return true;
}
bool MenuController::ShowContextMenu(MenuItemView* menu_item,
const gfx::Point& screen_location,
ui::mojom::MenuSourceType source_type) {
// Set the selection immediately, making sure the submenu is only open
// if it already was.
int selection_types = SELECTION_UPDATE_IMMEDIATELY;
if (state_.item == pending_state_.item && state_.submenu_open) {
selection_types |= SELECTION_OPEN_SUBMENU;
}
SetSelection(pending_state_.item, selection_types);
if (menu_item->GetDelegate()->ShowContextMenu(
menu_item, menu_item->GetCommand(), screen_location, source_type)) {
SendMouseCaptureLostToActiveView();
return true;
}
return false;
}
void MenuController::CloseAllNestedMenus() {
for (auto& nested_menu : menu_stack_) {
State& state = nested_menu.first;
MenuItemView* last_item = state.item;
for (MenuItemView* item = last_item; item;
item = item->GetParentMenuItem()) {
CloseMenu(item);
last_item = item;
}
state.submenu_open = false;
state.item = last_item;
}
}
MenuItemView* MenuController::GetMenuItemAt(View* source,
const gfx::Point& location) {
// Walk the view hierarchy until we find a menu item (or the root).
View* child_under_mouse = source->GetEventHandlerForPoint(location);
while (child_under_mouse && !IsViewClass<MenuItemView>(child_under_mouse)) {
child_under_mouse = child_under_mouse->parent();
}
return (child_under_mouse && child_under_mouse->GetEnabled())
? AsViewClass<MenuItemView>(child_under_mouse)
: nullptr;
}
MenuController::MenuPart MenuController::GetMenuPart(
SubmenuView* source,
const gfx::Point& source_loc) {
return GetMenuPartByScreenCoordinateUsingMenu(
state_.item, ConvertToScreen(*source, source_loc));
}
MenuController::MenuPart MenuController::GetMenuPartByScreenCoordinateUsingMenu(
MenuItemView* item,
const gfx::Point& screen_loc) {
MenuPart part;
for (; item; item = item->GetParentMenuItem()) {
if (item->SubmenuIsShowing() &&
GetMenuPartByScreenCoordinateImpl(item->GetSubmenu(), screen_loc,
&part)) {
return part;
}
}
return part;
}
bool MenuController::GetMenuPartByScreenCoordinateImpl(
SubmenuView* menu,
const gfx::Point& screen_loc,
MenuPart* part) {
gfx::Point menu_loc = ConvertFromScreen(*menu, screen_loc);
if (!Contains(*menu, menu_loc)) {
return false;
}
// Is the mouse over the scroll buttons?
const MenuPartType scroll_type = GetScrollButtonAt(menu, menu_loc);
if (scroll_type != MenuPartType::kNone) {
part->type = scroll_type;
part->submenu = menu;
return true;
}
// Not over the scroll button. Check the actual menu.
menu_loc = View::ConvertPointFromScreen(menu, screen_loc);
if (menu->GetVisibleBounds().Contains(menu_loc)) {
part->menu = GetMenuItemAt(menu, menu_loc);
part->type = MenuPartType::kMenuItem;
part->submenu = menu;
part->should_submenu_show =
part->submenu && part->menu &&
(part->menu->GetType() == MenuItemView::Type::kSubMenu ||
IsLocationOverSubmenuAreaOfActionableSubmenu(part->menu, screen_loc));
if (!part->menu) {
part->parent = menu->GetMenuItem();
}
return true;
}
// Return false for points on ash system UI menu shadows, to search parent
// menus.
if (use_ash_system_ui_layout_) {
return false;
}
// While the mouse isn't over a menu item or the scroll buttons of menu, it
// is contained by menu and so we return true. If we didn't return true other
// menus would be searched, even though they are likely obscured by us.
return true;
}
MenuHostRootView* MenuController::GetRootView(SubmenuView* submenu,
const gfx::Point& source_loc) {
MenuPart part = GetMenuPart(submenu, source_loc);
SubmenuView* view = part.submenu;
return view && view->GetWidget()
? static_cast<MenuHostRootView*>(view->GetWidget()->GetRootView())
: nullptr;
}
bool MenuController::IsLocationOverSubmenuAreaOfActionableSubmenu(
MenuItemView* item,
const gfx::Point& screen_loc) const {
if (!item || item->GetType() != MenuItemView::Type::kActionableSubMenu) {
return false;
}
gfx::Point view_loc = View::ConvertPointFromScreen(item, screen_loc);
if (base::i18n::IsRTL()) {
view_loc.set_x(item->GetMirroredXInView(view_loc.x()));
}
return item->GetSubmenuAreaOfActionableSubmenu().Contains(view_loc);
}
void MenuController::CommitPendingSelection() {
StopShowTimer();
size_t paths_differ_at = 0;
std::vector<MenuItemView*> current_path;
std::vector<MenuItemView*> new_path;
BuildPathsAndCalculateDiff(state_.item, pending_state_.item, &current_path,
&new_path, &paths_differ_at);
// Hide the old menu.
for (size_t i = paths_differ_at; i < current_path.size(); ++i) {
CloseMenu(current_path[i]);
}
state_ = pending_state_;
if (!state_.item) {
// Nothing to select.
StopScrollingViaButton();
return;
}
// Open all the submenus preceeding the last menu item (last menu item is
// handled next).
if (new_path.size() > 1) {
for (auto i = new_path.begin(); i != new_path.end() - 1; ++i) {
OpenMenu(*i);
}
}
if (state_.submenu_open) {
// The submenu should be open, open the submenu if the item has a submenu.
if (state_.item->HasSubmenu()) {
OpenMenu(state_.item);
} else {
state_.submenu_open = false;
}
} else if (state_.item->SubmenuIsShowing()) {
state_.item->GetSubmenu()->Hide();
}
if (scroll_task_.get() && scroll_task_->submenu()) {
// Stop the scrolling if none of the elements of the selection contain
// the menu being scrolled.
bool found = false;
for (MenuItemView* item = state_.item; item && !found;
item = item->GetParentMenuItem()) {
found = (item->SubmenuIsShowing() &&
item->GetSubmenu() == scroll_task_->submenu());
}
if (!found) {
StopScrollingViaButton();
}
}
}
void MenuController::CloseMenu(MenuItemView* item) {
DCHECK(item);
if (!item->HasSubmenu()) {
return;
}
for (MenuItemView* subitem : item->GetSubmenu()->GetMenuItems()) {
UnregisterAlertedItem(subitem);
}
item->GetSubmenu()->Hide();
}
void MenuController::OpenMenu(MenuItemView* item) {
DCHECK(item);
if (item->GetSubmenu()->IsShowing()) {
return;
}
OpenMenuImpl(item, true);
did_capture_ = true;
}
void MenuController::OpenMenuImpl(MenuItemView* item, bool show) {
// TODO(oshima|sky): Don't show the menu if drag is in progress and
// this menu doesn't support drag drop. See crbug.com/110495.
if (show) {
item->GetDelegate()->WillShowMenu(item);
item->UpdateEmptyMenusAndMetrics();
}
const MenuConfig& menu_config = MenuConfig::instance();
const size_t menu_depth = MenuDepth(item);
const MenuOpenDirection preferred_open_direction =
GetChildMenuOpenDirectionAtDepth(menu_depth);
MenuOpenDirection resulting_direction;
// Anchor for calculated bounds. Can be alternatively used by a system
// compositor for better positioning.
ui::OwnedWindowAnchor anchor;
const bool calculate_as_bubble_menu =
MenuItemView::IsBubble(state_.anchor) ||
menu_config.ShouldUseBubbleBorderForMenu(this);
gfx::Rect bounds =
calculate_as_bubble_menu
? CalculateBubbleMenuBounds(item, preferred_open_direction,
&resulting_direction, &anchor)
: CalculateMenuBounds(item, preferred_open_direction,
&resulting_direction, &anchor);
SetChildMenuOpenDirectionAtDepth(menu_depth, resulting_direction);
bool do_capture = (!did_capture_ && !for_drop_ && !IsEditableCombobox());
showing_submenu_ = true;
// Register alerted MenuItemViews so we can animate them. We do this here to
// handle both newly-opened submenus and submenus that have changed.
for (MenuItemView* subitem : item->GetSubmenu()->GetMenuItems()) {
if (subitem->is_alerted()) {
RegisterAlertedItem(subitem);
}
}
if (show) {
MenuHost::InitParams params;
params.parent = owner_;
params.bounds = bounds;
params.do_capture = do_capture;
params.native_view_for_gestures = native_view_for_gestures_;
params.owned_window_anchor = anchor;
if (item->GetParentMenuItem()) {
params.context = item->GetWidget();
// (crbug.com/1414232) The item to be open is a submenu. Make sure
// params.context is set.
DCHECK(params.context);
} else if (IsContextMenu()) {
if (!menu_stack_.empty()) {
auto* last_menu_item = menu_stack_.back().first.item.get();
if (state_.menu_type == MenuType::kContextMenu &&
last_menu_item->SubmenuIsShowing()) {
params.context = last_menu_item->GetSubmenu()->GetWidget();
} else {
if (state_.menu_type == MenuType::kMenuItemContextMenu &&
PlatformSetsParentForNonTopLevelWindows() &&
last_menu_item->SubmenuIsShowing()) {
// Before showing the new menu, ensure submenu of the last menu item
// is hidden on platforms like Linux Wayland where destroyed popup
// needs to be topmost. Without this, clicking on an item in the new
// menu leads to a crash.
last_menu_item->GetSubmenu()->Hide();
}
params.context = last_menu_item->GetWidget();
}
} else {
params.context = owner_;
}
} else {
params.context = owner_;
}
item->GetSubmenu()->ShowAt(params);
// Figure out if the mouse is under the menu; if so, remember the mouse
// location so we can ignore the first mouse move event(s) with that
// location. We do this after `ShowAt` because `ConvertFromScreen` doesn't
// work correctly if the widget isn't shown.
if (item->GetSubmenu()->GetWidget()) {
const gfx::Point mouse_pos = ConvertFromScreen(
*item->submenu_, display::Screen::Get()->GetCursorScreenPoint());
MenuPart part_under_mouse = GetMenuPart(item->submenu_.get(), mouse_pos);
if (part_under_mouse.type != MenuPartType::kNone) {
menu_open_mouse_loc_ =
GetLocationInRootMenu(*item->submenu_, mouse_pos);
}
}
item->GetSubmenu()->GetWidget()->SetNativeWindowProperty(
TooltipManager::kGroupingPropertyKey,
reinterpret_cast<void*>(MenuConfig::kMenuControllerGroupingId));
// Set the selection indices for this menu level based on traversal order.
SetSelectionIndices(item);
} else {
item->GetSubmenu()->Reposition(bounds, anchor);
}
showing_submenu_ = false;
}
void MenuController::MenuChildrenChanged(MenuItemView* item) {
DCHECK(item);
// Menu shouldn't be updated during drag operation.
DCHECK(!active_mouse_view_tracker_->view());
// If needed, refresh the AX index assignments.
if (item->GetProperty(kOrderedMenuChildren)) {
SetSelectionIndices(item);
}
// If the current item or pending item is a descendant of the item
// that changed, move the selection back to the changed item.
const MenuItemView* ancestor = state_.item;
while (ancestor && ancestor != item) {
ancestor = ancestor->GetParentMenuItem();
}
if (!ancestor) {
ancestor = pending_state_.item;
while (ancestor && ancestor != item) {
ancestor = ancestor->GetParentMenuItem();
}
if (!ancestor) {
return;
}
}
SetSelection(item, SELECTION_OPEN_SUBMENU | SELECTION_UPDATE_IMMEDIATELY);
if (item->HasSubmenu()) {
OpenMenuImpl(item, false);
}
}
void MenuController::BuildPathsAndCalculateDiff(
MenuItemView* old_item,
MenuItemView* new_item,
std::vector<MenuItemView*>* old_path,
std::vector<MenuItemView*>* new_path,
size_t* first_diff_at) {
DCHECK(old_path);
DCHECK(new_path);
DCHECK(first_diff_at);
BuildMenuItemPath(old_item, old_path);
BuildMenuItemPath(new_item, new_path);
*first_diff_at = static_cast<size_t>(std::distance(
old_path->begin(), std::ranges::mismatch(*old_path, *new_path).in1));
}
void MenuController::BuildMenuItemPath(MenuItemView* item,
std::vector<MenuItemView*>* path) {
if (!item) {
return;
}
BuildMenuItemPath(item->GetParentMenuItem(), path);
path->push_back(item);
}
void MenuController::StartShowTimer() {
show_timer_.Start(FROM_HERE,
base::Milliseconds(MenuConfig::instance().show_delay), this,
&MenuController::CommitPendingSelection);
}
void MenuController::StopShowTimer() {
show_timer_.Stop();
}
void MenuController::StartCancelAllTimer() {
cancel_all_timer_.Start(
FROM_HERE, base::Milliseconds(kCloseOnExitTime),
base::BindOnce(&MenuController::Cancel, base::Unretained(this),
ExitType::kAll));
}
void MenuController::StopCancelAllTimer() {
cancel_all_timer_.Stop();
}
gfx::Rect MenuController::CalculateMenuBounds(
MenuItemView* item,
MenuOpenDirection preferred_open_direction,
MenuOpenDirection* resulting_direction,
ui::OwnedWindowAnchor* anchor) {
DCHECK(item);
DCHECK(anchor);
SubmenuView* submenu = item->GetSubmenu();
DCHECK(submenu);
// For the first menu, anchor_rect is initial bounds. Otherwise, it is the top
// of the menu item that spawned this menu.
// TODO(pkasting): Not clear to me why we want to set the height to 1 dip.
const bool is_child_menu = !!item->GetParentMenuItem();
gfx::Rect anchor_bounds =
is_child_menu ? item->GetBoundsInScreen() : state_.initial_bounds;
if (is_child_menu) {
anchor_bounds.set_height(1);
}
anchor->anchor_rect = anchor_bounds;
SetAnchorParametersForItem(item, anchor_bounds.origin(), anchor);
const auto* const scroll_view_container = submenu->GetScrollViewContainer();
gfx::Rect menu_bounds =
gfx::Rect(scroll_view_container->GetPreferredSize({}));
const gfx::Rect& monitor_bounds = state_.monitor_bounds;
// For comboboxes, ensure the menu is at least as wide as the anchor.
if (IsCombobox()) {
menu_bounds.set_width(std::max(menu_bounds.width(), anchor_bounds.width()));
}
// Don't let the menu go too wide or too tall.
menu_bounds.set_width(std::min(
menu_bounds.width(), item->GetDelegate()->GetMaxWidthForMenu(item)));
if (!monitor_bounds.IsEmpty()) {
menu_bounds.set_width(
std::min(menu_bounds.width(), monitor_bounds.width()));
menu_bounds.set_height(
std::min(menu_bounds.height(), monitor_bounds.height()));
}
// Assume we can honor preferred_open_direction.
*resulting_direction = preferred_open_direction;
const MenuConfig& menu_config = MenuConfig::instance();
// Not the first menu; position it relative to the bounds of its parent menu
// item.
if (is_child_menu) {
// We must make sure we take into account the UI layout. If the layout is
// RTL, then a 'leading' menu is positioned to the left of the parent menu
// item and not to the right.
const bool layout_is_rtl = base::i18n::IsRTL();
const bool create_on_right =
layout_is_rtl ? preferred_open_direction == MenuOpenDirection::kTrailing
: preferred_open_direction == MenuOpenDirection::kLeading;
const int left_of_parent = anchor_bounds.x() - menu_bounds.width() +
menu_config.submenu_horizontal_overlap;
const int right_of_parent =
anchor_bounds.right() - menu_config.submenu_horizontal_overlap;
menu_bounds.set_y(anchor_bounds.y() -
scroll_view_container->GetInsets().top());
// Assume the menu can be placed in the preferred location.
menu_bounds.set_x(create_on_right ? right_of_parent : left_of_parent);
// Everything after this check requires monitor bounds to be non-empty.
if (ShouldIgnoreScreenBoundsForMenus() || monitor_bounds.IsEmpty()) {
return menu_bounds;
}
// Menu does not actually fit where it was placed, move it to the other side
// and update `resulting_direction`.
if (menu_bounds.x() < monitor_bounds.x()) {
*resulting_direction = layout_is_rtl ? MenuOpenDirection::kTrailing
: MenuOpenDirection::kLeading;
menu_bounds.set_x(right_of_parent);
} else if (menu_bounds.right() > monitor_bounds.right()) {
*resulting_direction = layout_is_rtl ? MenuOpenDirection::kLeading
: MenuOpenDirection::kTrailing;
menu_bounds.set_x(left_of_parent);
}
} else {
using MenuPosition = MenuItemView::MenuPosition;
// First item, align top left corner of menu with bottom left corner of
// anchor bounds.
menu_bounds.set_x(anchor_bounds.x());
menu_bounds.set_y(anchor_bounds.bottom());
const int above_anchor = anchor_bounds.y() - menu_bounds.height();
if (state_.anchor == MenuAnchorPosition::kTopRight) {
// Move the menu so that its right edge is aligned with the anchor
// bounds right edge.
menu_bounds.set_x(anchor_bounds.right() - menu_bounds.width());
} else if (state_.anchor == MenuAnchorPosition::kBottomCenter) {
// Try to fit the menu above the anchor bounds. If it doesn't fit, place
// it below.
const int horizontally_centered =
anchor_bounds.x() + (anchor_bounds.width() - menu_bounds.width()) / 2;
menu_bounds.set_x(horizontally_centered);
menu_bounds.set_y(above_anchor - kTouchYPadding);
if (!ShouldIgnoreScreenBoundsForMenus() &&
menu_bounds.y() < monitor_bounds.y()) {
menu_bounds.set_y(anchor_bounds.y() + kTouchYPadding);
}
}
if (item->actual_menu_position() == MenuPosition::kAboveBounds) {
// Menu has already been drawn above, put it above the anchor bounds.
menu_bounds.set_y(above_anchor);
}
// Everything beyond this point requires monitor bounds to be non-empty.
if (ShouldIgnoreScreenBoundsForMenus() || monitor_bounds.IsEmpty()) {
return menu_bounds;
}
// If the menu position is below or above the anchor bounds, force it to fit
// on the screen. Otherwise, try to fit the menu in the following locations:
// 1.) Below the anchor bounds
// 2.) Above the anchor bounds
// 3.) At the bottom of the monitor and off the side of the anchor bounds
if (item->actual_menu_position() == MenuPosition::kBelowBounds ||
item->actual_menu_position() == MenuPosition::kAboveBounds) {
// Menu has been drawn below/above the anchor bounds, make sure it fits
// on the screen in its current location.
const int drawn_width = menu_bounds.width();
menu_bounds.Intersect(monitor_bounds);
// Do not allow the menu to get narrower. This handles the case where the
// menu would have drawn off-screen, but the effective anchor was shifted
// at the end of this function. Preserve the width, so it is shifted
// again.
menu_bounds.set_width(drawn_width);
} else if (menu_bounds.bottom() <= monitor_bounds.bottom()) {
// Menu fits below anchor bounds.
item->set_actual_menu_position(MenuPosition::kBelowBounds);
} else if (above_anchor >= monitor_bounds.y()) {
// Menu fits above anchor bounds.
menu_bounds.set_y(above_anchor);
item->set_actual_menu_position(MenuPosition::kAboveBounds);
} else if (item->GetDelegate()->ShouldTryPositioningBesideAnchor()) {
const int left_of_anchor = anchor_bounds.x() - menu_bounds.width();
const int right_of_anchor = anchor_bounds.right();
menu_bounds.set_y(monitor_bounds.bottom() - menu_bounds.height());
if (state_.anchor == MenuAnchorPosition::kTopLeft) {
// Prefer menu to right of anchor bounds but move it to left if it
// doesn't fit.
menu_bounds.set_x(right_of_anchor);
if (menu_bounds.right() > monitor_bounds.right()) {
menu_bounds.set_x(left_of_anchor);
}
} else {
// Prefer menu to left of anchor bounds but move it to right if it
// doesn't fit.
menu_bounds.set_x(left_of_anchor);
if (menu_bounds.x() < monitor_bounds.x()) {
menu_bounds.set_x(right_of_anchor);
}
}
} else {
// The delegate doesn't want the menu repositioned to the side, and it
// doesn't fit on the screen in any orientation - just clip the menu to
// the screen and let the scrolling arrows appear.
menu_bounds.Intersect(monitor_bounds);
}
}
// Ensure the menu is not displayed off screen.
menu_bounds.set_x(
ClampWithCrashKeys(menu_bounds.x(), monitor_bounds.x(),
monitor_bounds.right() - menu_bounds.width(),
anchor_bounds, menu_bounds, monitor_bounds));
menu_bounds.set_y(
ClampWithCrashKeys(menu_bounds.y(), monitor_bounds.y(),
monitor_bounds.bottom() - menu_bounds.height(),
anchor_bounds, menu_bounds, monitor_bounds));
return menu_bounds;
}
gfx::Rect MenuController::CalculateBubbleMenuBounds(
MenuItemView* item,
MenuOpenDirection preferred_open_direction,
MenuOpenDirection* resulting_direction,
ui::OwnedWindowAnchor* anchor) {
DCHECK(item);
DCHECK(anchor);
// For the first menu, anchor_rect is initial bounds. Otherwise, it is the top
// of the menu item that spawned this menu.
// TODO(pkasting): Not clear to me why we want to set the height to 1 dip.
const bool is_child_menu = !!item->GetParentMenuItem();
gfx::Rect anchor_bounds =
is_child_menu ? item->GetBoundsInScreen() : state_.initial_bounds;
if (is_child_menu) {
anchor_bounds.set_height(1);
}
anchor->anchor_rect = anchor_bounds;
SetAnchorParametersForItem(item, anchor_bounds.origin(), anchor);
// Assume we can honor `preferred_open_direction`.
*resulting_direction = preferred_open_direction;
SubmenuView* submenu = item->GetSubmenu();
CHECK(submenu);
const auto* const scroll_view_container = submenu->GetScrollViewContainer();
gfx::Size menu_size = scroll_view_container->GetPreferredSize({});
// Respect the delegate's maximum width.
menu_size.set_width(std::min(menu_size.width(),
item->GetDelegate()->GetMaxWidthForMenu(item)));
// For comboboxes, ensure the menu is at least as wide as the anchor.
const gfx::Insets border_insets =
scroll_view_container->outside_border_insets();
if (IsCombobox()) {
menu_size.SetToMax({anchor_bounds.width() + border_insets.width(), 0});
}
int x = 0;
int y = 0;
const gfx::Rect& monitor_bounds = state_.monitor_bounds;
const MenuConfig& menu_config = MenuConfig::instance();
if (!is_child_menu) {
// This is a top-level menu, position it relative to the anchor bounds.
using MenuPosition = MenuItemView::MenuPosition;
// First the size gets reduced to the possible space.
const bool is_anchored_bubble = MenuItemView::IsBubble(state_.anchor);
if (!monitor_bounds.IsEmpty()) {
int max_width = monitor_bounds.width() + border_insets.width();
int max_height = monitor_bounds.height() + border_insets.height();
if (!IsContextMenu()) {
// In case of bubbles, the maximum width is limited by the space
// between the display corner and the target area + the tip size.
const bool is_bubble_menu =
menu_config.ShouldUseBubbleBorderForMenu(this);
if (is_anchored_bubble || is_bubble_menu ||
item->actual_menu_position() == MenuPosition::kAboveBounds) {
// menu_size is expected to include not just the content size
// but also the (border and shadow) insets, which can go offscreen.
// When anchor_bounds is above or below monitor_bounds, max_height
// calculation will be larger than monitor+insets. To prevent
// std::clamp crashing due to y_max < y_min, std::min with current
// max_height.
max_height = std::min(
max_height,
std::max(anchor_bounds.y() - monitor_bounds.y(),
monitor_bounds.bottom() - anchor_bounds.bottom()) -
(is_bubble_menu ? 0 : menu_config.touchable_anchor_offset) +
border_insets.height());
}
}
// The menu should always have a non-empty available area.
DCHECK_GE(max_width, kBubbleTipSizeLeftRight);
DCHECK_GE(max_height, kBubbleTipSizeTopBottom);
menu_size.SetToMin(gfx::Size(max_width, max_height));
}
// Calculate possible coordinates. Do not clamp values; that happens later.
int x_menu_on_left = 0;
int x_menu_on_right = 0;
int y_menu_above = 0;
int y_menu_below = 0;
switch (state_.anchor) {
case MenuAnchorPosition::kBubbleTopLeft:
case MenuAnchorPosition::kBubbleTopRight:
case MenuAnchorPosition::kBubbleBottomLeft:
case MenuAnchorPosition::kBubbleBottomRight:
case MenuAnchorPosition::kTopLeft:
case MenuAnchorPosition::kTopRight:
case MenuAnchorPosition::kBottomCenter:
// Align the right edges of the menu and anchor.
x_menu_on_left = anchor_bounds.right() -
(state_.anchor == MenuAnchorPosition::kBottomCenter
? menu_size.width() / 2
: menu_size.width()) +
border_insets.right();
// Align the left edges of the menu and anchor.
x_menu_on_right = anchor_bounds.x() - border_insets.left();
// Align the bottom of the menu with the top of the anchor.
y_menu_above =
anchor_bounds.y() - menu_size.height() + border_insets.bottom() -
(is_anchored_bubble ? menu_config.touchable_anchor_offset : 0);
// Align the top of the menu with the bottom of the anchor.
y_menu_below =
anchor_bounds.bottom() - border_insets.top() +
(is_anchored_bubble ? menu_config.touchable_anchor_offset : 0);
break;
case MenuAnchorPosition::kBubbleLeft:
case MenuAnchorPosition::kBubbleRight:
// Align the right edge of the menu with the left edge of the anchor.
x_menu_on_left = anchor_bounds.x() - menu_size.width() +
border_insets.right() -
menu_config.touchable_anchor_offset;
// Align the left edge of the menu with the right edge of the anchor.
x_menu_on_right = anchor_bounds.right() - border_insets.left() +
menu_config.touchable_anchor_offset;
// Align the bottom of the menu with the bottom of the anchor.
y_menu_above = anchor_bounds.bottom() - menu_size.height() +
border_insets.bottom();
// Align the top of the menu with the top of the anchor.
y_menu_below = anchor_bounds.y() - border_insets.top();
break;
}
// Choose the most appropriate x coordinate.
switch (state_.anchor) {
case MenuAnchorPosition::kBubbleTopLeft:
case MenuAnchorPosition::kBubbleLeft:
case MenuAnchorPosition::kBubbleBottomLeft:
case MenuAnchorPosition::kTopRight:
case MenuAnchorPosition::kBottomCenter:
x = x_menu_on_left + border_insets.left() >= monitor_bounds.x()
? x_menu_on_left
: x_menu_on_right;
break;
case MenuAnchorPosition::kBubbleTopRight:
case MenuAnchorPosition::kBubbleRight:
case MenuAnchorPosition::kBubbleBottomRight:
case MenuAnchorPosition::kTopLeft:
x = x_menu_on_right + menu_size.width() - border_insets.right() <=
monitor_bounds.right()
? x_menu_on_right
: x_menu_on_left;
break;
}
// Choose the most appropriate y coordinate.
const bool able_to_show_menu_below =
y_menu_below + menu_size.height() - border_insets.bottom() <=
monitor_bounds.bottom();
const bool able_to_show_menu_above =
y_menu_above + border_insets.top() >= monitor_bounds.y();
switch (state_.anchor) {
case MenuAnchorPosition::kBubbleLeft:
case MenuAnchorPosition::kBubbleRight:
case MenuAnchorPosition::kBubbleBottomLeft:
case MenuAnchorPosition::kBubbleBottomRight:
case MenuAnchorPosition::kTopLeft:
case MenuAnchorPosition::kTopRight:
case MenuAnchorPosition::kBottomCenter:
// Respect the actual menu position calculated earlier if possible, to
// prevent changing positions during menu size updates.
if (able_to_show_menu_below &&
(item->actual_menu_position() != MenuPosition::kAboveBounds ||
!able_to_show_menu_above)) {
y = y_menu_below;
item->set_actual_menu_position(MenuPosition::kBelowBounds);
} else if (able_to_show_menu_above) {
y = y_menu_above;
item->set_actual_menu_position(MenuPosition::kAboveBounds);
} else {
// No room above or below. Show the menu as low as possible.
y = monitor_bounds.bottom() + border_insets.bottom() -
menu_size.height();
item->set_actual_menu_position(MenuPosition::kBestFit);
}
break;
case MenuAnchorPosition::kBubbleTopLeft:
case MenuAnchorPosition::kBubbleTopRight:
// Respect the actual menu position calculated earlier if possible, to
// prevent changing positions during menu size updates.
if (able_to_show_menu_above &&
(item->actual_menu_position() != MenuPosition::kBelowBounds ||
!able_to_show_menu_below)) {
y = y_menu_above;
item->set_actual_menu_position(MenuPosition::kAboveBounds);
} else if (able_to_show_menu_below) {
y = y_menu_below;
item->set_actual_menu_position(MenuPosition::kBelowBounds);
} else {
// No room above or below. Show the menu as high as possible.
y = monitor_bounds.y() - border_insets.top();
item->set_actual_menu_position(MenuPosition::kBestFit);
}
break;
}
// The above adjustments may have shifted a large menu off the screen.
// Clamp the menu origin to the valid range.
const int x_min = monitor_bounds.x() - border_insets.left();
const int x_max =
monitor_bounds.right() - menu_size.width() + border_insets.right();
const int y_min = monitor_bounds.y() - border_insets.top();
const int y_max =
monitor_bounds.bottom() - menu_size.height() + border_insets.bottom();
x = ClampWithCrashKeys(x, x_min, x_max, anchor_bounds,
gfx::Rect(gfx::Point(x, y), menu_size),
monitor_bounds, border_insets);
y = ClampWithCrashKeys(y, y_min, y_max, anchor_bounds,
gfx::Rect(gfx::Point(x, y), menu_size),
monitor_bounds, border_insets);
} else {
// This is a sub-menu, position it relative to the parent menu.
// If the layout is RTL, then a 'leading' menu is positioned to the left of
// the parent menu item and not to the right.
const bool create_on_right =
base::i18n::IsRTL()
? preferred_open_direction == MenuOpenDirection::kTrailing
: preferred_open_direction == MenuOpenDirection::kLeading;
const int width_with_right_inset =
menu_size.width() - border_insets.right();
const int x_min = monitor_bounds.x() - border_insets.left();
const int x_max = monitor_bounds.right() - width_with_right_inset;
const int x_left = anchor_bounds.x() - width_with_right_inset +
menu_config.submenu_horizontal_overlap;
const int x_right = anchor_bounds.right() - border_insets.left() -
menu_config.submenu_horizontal_overlap;
if (create_on_right) {
if (monitor_bounds.width() == 0 || x_right <= x_max) {
// Enough room on the right, show normally.
x = x_right;
} else if (x_left >= x_min) {
// Enough room on the left, show there.
*resulting_direction = preferred_open_direction;
x = x_left;
} else {
// No room on either side. Flush the menu to the right edge.
x = x_max;
}
} else {
if (monitor_bounds.width() == 0 || x_left >= x_min) {
// Enough room on the left, show normally.
x = x_left;
} else if (x_right <= x_max) {
// Enough room on the right, show there.
*resulting_direction =
preferred_open_direction == MenuOpenDirection::kLeading
? MenuOpenDirection::kTrailing
: MenuOpenDirection::kLeading;
x = x_right;
} else {
// No room on either side. Flush the menu to the left edge.
x = x_min;
}
}
// Make sure the menu doesn't exceed the monitor bounds while cancelling
// out the border and shadow at the top and bottom.
menu_size.set_height(std::min(
menu_size.height(), monitor_bounds.height() + border_insets.height()));
const int corner_radius = menu_config.CornerRadiusForMenu(this);
y = anchor_bounds.y() - border_insets.top() -
(use_ash_system_ui_layout_
? menu_config.vertical_touchable_menu_item_padding
: menu_config.rounded_menu_vertical_border_size.value_or(
corner_radius));
auto y_min = monitor_bounds.y() - border_insets.top();
auto y_max =
monitor_bounds.bottom() + border_insets.bottom() - menu_size.height();
y = ClampWithCrashKeys(y, y_min, y_max, anchor_bounds,
gfx::Rect(gfx::Point(x, y), menu_size),
monitor_bounds, border_insets);
}
return gfx::Rect({x, y}, menu_size);
}
// static
size_t MenuController::MenuDepth(MenuItemView* item) {
return item ? (MenuDepth(item->GetParentMenuItem()) + 1) : size_t{0};
}
void MenuController::IncrementSelection(
SelectionIncrementDirectionType direction) {
MenuItemView* item = pending_state_.item;
DCHECK(item);
if (pending_state_.submenu_open && item->SubmenuIsShowing()) {
// A menu is selected and open, but none of its children are selected,
// select the first menu item that is visible and enabled.
if (!item->GetSubmenu()->GetMenuItems().empty()) {
MenuItemView* to_select = FindInitialSelectableMenuItem(item, direction);
SetInitialHotTrackedView(to_select, direction);
return;
}
}
if (!item->children().empty()) {
Button* button = GetFirstHotTrackedView(item);
if (button) {
DCHECK_EQ(hot_button_, button);
}
bool direction_is_down = direction == INCREMENT_SELECTION_DOWN;
View* to_make_hot =
button ? GetNextFocusableView(item, button, direction_is_down)
: GetInitialFocusableView(item, direction_is_down);
Button* hot_button = Button::AsButton(to_make_hot);
if (hot_button) {
SetHotTrackedButton(hot_button);
return;
}
}
SetNextHotTrackedView(item, direction);
}
void MenuController::SetSelectionIndices(MenuItemView* parent) {
if (parent->GetProperty(kOrderedMenuChildren)) {
// Clear any old AX index assignments.
for (ViewTracker& item : *(parent->GetProperty(kOrderedMenuChildren))) {
if (item.view()) {
item.view()->GetViewAccessibility().ClearPosInSet();
item.view()->GetViewAccessibility().ClearSetSize();
}
}
}
std::vector<View*> ordering;
SubmenuView* const submenu = parent->GetSubmenu();
for (MenuItemView* item : submenu->GetMenuItems()) {
if (!item->IsTraversableByKeyboard()) {
continue;
}
bool found_focusable = false;
if (!item->children().empty()) {
for (View* child = GetInitialFocusableView(item, true); child;
child = GetNextFocusableView(item, child, true)) {
ordering.push_back(child);
found_focusable = true;
}
}
if (!found_focusable) {
ordering.push_back(item);
}
}
parent->SetProperty(kOrderedMenuChildren,
std::make_unique<std::vector<ViewTracker>>(
ordering.begin(), ordering.end()));
if (ordering.empty()) {
return;
}
const size_t set_size = ordering.size();
for (size_t i = 0; i < set_size; ++i) {
ordering[i]->GetViewAccessibility().SetPosInSet(static_cast<int>(i + 1));
ordering[i]->GetViewAccessibility().SetSetSize(static_cast<int>(set_size));
}
}
void MenuController::MoveSelectionToFirstOrLastItem(
SelectionIncrementDirectionType direction) {
MenuItemView* item = pending_state_.item;
DCHECK(item);
MenuItemView* submenu = nullptr;
if (pending_state_.submenu_open && item->SubmenuIsShowing()) {
if (item->GetSubmenu()->GetMenuItems().empty()) {
return;
}
// A menu is selected and open, but none of its children are selected,
// select the first or last menu item that is visible and enabled.
submenu = item;
} else {
submenu = item->GetParentMenuItem();
}
MenuItemView* to_select = FindInitialSelectableMenuItem(submenu, direction);
SetInitialHotTrackedView(to_select, direction);
}
MenuItemView* MenuController::FindInitialSelectableMenuItem(
MenuItemView* parent,
SelectionIncrementDirectionType direction) {
const size_t parent_count = parent->GetSubmenu()->GetMenuItems().size();
if (direction == INCREMENT_SELECTION_DOWN) {
for (size_t index = 0; index < parent_count; ++index) {
MenuItemView* child = parent->GetSubmenu()->GetMenuItemAt(index);
if (child->IsTraversableByKeyboard()) {
return child;
}
}
} else {
for (size_t index = parent_count; index > 0; --index) {
MenuItemView* child = parent->GetSubmenu()->GetMenuItemAt(index - 1);
if (child->IsTraversableByKeyboard()) {
return child;
}
}
}
return nullptr;
}
void MenuController::OpenSubmenuChangeSelectionIfCan() {
MenuItemView* item = pending_state_.item;
if (!item->HasSubmenu() || !item->GetEnabled()) {
return;
}
// Show the sub-menu.
SetSelection(item, SELECTION_OPEN_SUBMENU | SELECTION_UPDATE_IMMEDIATELY);
MenuItemView* to_select = nullptr;
if (!item->GetSubmenu()->GetMenuItems().empty()) {
to_select = FindInitialSelectableMenuItem(item, INCREMENT_SELECTION_DOWN);
}
if (to_select) {
// Selection is going from the ACTIONABLE to the SUBMENU region of the
// ACTIONABLE_SUBMENU, so highlight the SUBMENU area.
if (item->type_ == MenuItemView::Type::kActionableSubMenu) {
item->SetSelectionOfActionableSubmenu(true);
}
SetSelection(to_select, SELECTION_UPDATE_IMMEDIATELY);
}
}
void MenuController::CloseSubmenu() {
MenuItemView* item = state_.item;
DCHECK(item);
if (!item->GetParentMenuItem()) {
return;
}
if (item->SubmenuIsShowing()) {
SetSelection(item, SELECTION_UPDATE_IMMEDIATELY);
} else if (item->GetParentMenuItem()->GetParentMenuItem()) {
SetSelection(item->GetParentMenuItem(), SELECTION_UPDATE_IMMEDIATELY);
}
}
MenuController::SelectByCharDetails MenuController::FindChildForMnemonic(
MenuItemView* parent,
char16_t key,
bool (*match_function)(MenuItemView* menu, char16_t mnemonic)) {
SubmenuView* submenu = parent->GetSubmenu();
DCHECK(submenu);
SelectByCharDetails details;
const auto menu_items = submenu->GetMenuItems();
for (size_t i = 0; i < menu_items.size(); ++i) {
MenuItemView* child = menu_items[i];
if (child->GetEnabled() && child->GetVisible()) {
if (child == pending_state_.item) {
details.index_of_item = i;
}
if (match_function(child, key)) {
if (!details.first_match.has_value()) {
details.first_match = i;
} else {
details.has_multiple = true;
}
if (!details.next_match.has_value() &&
details.index_of_item.has_value() && i > details.index_of_item) {
details.next_match = i;
}
}
}
}
return details;
}
void MenuController::AcceptOrSelect(MenuItemView* parent,
const SelectByCharDetails& details) {
// This should only be invoked if there is a match.
DCHECK(details.first_match.has_value());
DCHECK(parent->HasSubmenu());
SubmenuView* submenu = parent->GetSubmenu();
DCHECK(submenu);
if (!details.has_multiple) {
// There's only one match, activate it (or open if it has a submenu).
if (submenu->GetMenuItemAt(details.first_match.value())->HasSubmenu()) {
SetSelection(submenu->GetMenuItemAt(details.first_match.value()),
SELECTION_OPEN_SUBMENU | SELECTION_UPDATE_IMMEDIATELY);
} else {
Accept(submenu->GetMenuItemAt(details.first_match.value()), 0);
}
} else if (!details.index_of_item.has_value() ||
!details.next_match.has_value()) {
SetSelection(submenu->GetMenuItemAt(details.first_match.value()),
SELECTION_DEFAULT);
} else {
SetSelection(submenu->GetMenuItemAt(details.next_match.value()),
SELECTION_DEFAULT);
}
}
void MenuController::SelectByChar(char16_t character) {
// Do not process while performing drag-and-drop.
if (for_drop_) {
return;
}
if (!character) {
return;
}
char16_t char_array[] = {character, 0};
char16_t key = base::i18n::ToLower(char_array)[0];
MenuItemView* item = pending_state_.item;
if (!item) {
return;
}
if (!item->SubmenuIsShowing()) {
item = item->GetParentMenuItem();
}
DCHECK(item);
DCHECK(item->HasSubmenu());
DCHECK(item->GetSubmenu());
if (!item) {
return;
}
if (item->GetSubmenu()->GetMenuItems().empty()) {
return;
}
// Look for matches based on mnemonic first.
SelectByCharDetails details =
FindChildForMnemonic(item, key, &MatchesMnemonic);
if (details.first_match.has_value()) {
AcceptOrSelect(item, details);
return;
}
if (IsReadonlyCombobox() ||
MenuConfig::instance().all_menus_use_prefix_selection) {
item->GetSubmenu()->GetPrefixSelector()->InsertText(
char_array,
ui::TextInputClient::InsertTextCursorBehavior::kMoveCursorAfterText);
} else {
// If no mnemonics found, look at first character of titles.
details = FindChildForMnemonic(item, key, &TitleMatchesMnemonic);
if (details.first_match.has_value()) {
AcceptOrSelect(item, details);
}
}
}
void MenuController::RepostEventAndCancel(SubmenuView* source,
const ui::LocatedEvent* event) {
const gfx::Point screen_loc = ConvertToScreen(*source, event->location());
#if BUILDFLAG(IS_WIN)
if (event->IsMouseEvent() || event->IsTouchEvent()) {
base::WeakPtr<MenuController> this_ref = AsWeakPtr();
if (state_.item) {
// This must be done before we ReleaseCapture() below, which can lead to
// deleting the `source`.
gfx::NativeView native_view = source->GetWidget()->GetNativeView();
gfx::NativeWindow window =
native_view
? display::Screen::Get()->GetWindowAtScreenPoint(screen_loc)
: nullptr;
state_.item->GetRootMenuItem()->GetSubmenu()->ReleaseCapture();
// We're going to close and we own the event capture. We need to repost
// the event, otherwise the window the user clicked on won't get the
// event.
RepostEventImpl(event, screen_loc, native_view, window);
} else {
// We some times get an event after closing all the menus. Ignore it. Make
// sure the menu is in fact not visible. If the menu is visible, then
// we're in a bad state where we think the menu isn't visible but it is.
DCHECK(!source->GetWidget()->IsVisible());
}
// Reposting the event may have deleted this, if so exit.
if (!this_ref) {
return;
}
}
#endif
// Determine target to see if a complete or partial close of the menu should
// occur.
ExitType exit_type = ExitType::kAll;
if (!menu_stack_.empty()) {
// We're running nested menus. Only exit all if the mouse wasn't over one
// of the menus from the last run.
MenuPart last_part = GetMenuPartByScreenCoordinateUsingMenu(
menu_stack_.back().first.item, screen_loc);
if (last_part.type != MenuPartType::kNone) {
exit_type = ExitType::kOutermost;
}
}
#if BUILDFLAG(IS_MAC)
// When doing a menu closure animation, target the deepest submenu - that way
// MenuClosureAnimationMac will fade out all the menus in sync, rather than
// the shallowest menu only.
menu_closure_animation_ = std::make_unique<MenuClosureAnimationMac>(
nullptr, state_.item->GetSubmenu(),
base::BindOnce(&MenuController::Cancel, base::Unretained(this),
exit_type));
menu_closure_animation_->Start();
#else
Cancel(exit_type);
#endif
}
void MenuController::SetDropMenuItem(MenuItemView* new_target,
MenuDelegate::DropPosition new_position) {
if (new_target == drop_target_ && new_position == drop_position_) {
return;
}
if (drop_target_) {
drop_target_->GetParentMenuItem()->GetSubmenu()->SetDropMenuItem(
nullptr, MenuDelegate::DropPosition::kNone);
}
drop_target_ = new_target;
drop_position_ = new_position;
if (drop_target_) {
drop_target_->GetParentMenuItem()->GetSubmenu()->SetDropMenuItem(
drop_target_, drop_position_);
}
}
void MenuController::UpdateScrolling(const MenuPart& part) {
if (!part.is_scroll() && !scroll_task_.get()) {
return;
}
if (!scroll_task_.get()) {
scroll_task_ = std::make_unique<MenuScrollTask>();
}
scroll_task_->Update(part);
}
void MenuController::StopScrollingViaButton() {
scroll_task_.reset(nullptr);
}
void MenuController::UpdateActiveMouseView(SubmenuView* event_source,
const ui::MouseEvent& event,
View* target_menu) {
View* target = nullptr;
gfx::Point target_menu_loc(event.location());
if (target_menu && !target_menu->children().empty()) {
// Locate the deepest child view to send events to. This code assumes we
// don't have to walk up the tree to find a view interested in events. This
// is currently true for the cases we are embedding views, but if we embed
// more complex hierarchies it'll need to change.
target_menu_loc = ConvertToScreen(*event_source, target_menu_loc);
View::ConvertPointFromScreen(target_menu, &target_menu_loc);
target = target_menu->GetEventHandlerForPoint(target_menu_loc);
if (target == target_menu || !target->GetEnabled()) {
target = nullptr;
}
}
View* active_mouse_view = active_mouse_view_tracker_->view();
if (target != active_mouse_view) {
SendMouseCaptureLostToActiveView();
active_mouse_view = target;
active_mouse_view_tracker_->SetView(active_mouse_view);
if (active_mouse_view) {
gfx::Point target_point(target_menu_loc);
View::ConvertPointToTarget(target_menu, active_mouse_view, &target_point);
ui::MouseEvent mouse_entered_event(ui::EventType::kMouseEntered,
target_point, target_point,
ui::EventTimeForNow(), 0, 0);
active_mouse_view->OnMouseEntered(mouse_entered_event);
ui::MouseEvent mouse_pressed_event(
ui::EventType::kMousePressed, target_point, target_point,
ui::EventTimeForNow(), event.flags(), event.changed_button_flags());
active_mouse_view->OnMousePressed(mouse_pressed_event);
}
}
if (active_mouse_view) {
gfx::Point target_point(target_menu_loc);
View::ConvertPointToTarget(target_menu, active_mouse_view, &target_point);
ui::MouseEvent mouse_dragged_event(
ui::EventType::kMouseDragged, target_point, target_point,
ui::EventTimeForNow(), event.flags(), event.changed_button_flags());
active_mouse_view->OnMouseDragged(mouse_dragged_event);
}
}
void MenuController::SendMouseReleaseToActiveView(SubmenuView* event_source,
const ui::MouseEvent& event) {
View* active_mouse_view = active_mouse_view_tracker_->view();
if (!active_mouse_view) {
return;
}
const gfx::Point target_loc = View::ConvertPointFromScreen(
active_mouse_view, ConvertToScreen(*event_source, event.location()));
ui::MouseEvent release_event(ui::EventType::kMouseReleased, target_loc,
target_loc, ui::EventTimeForNow(), event.flags(),
event.changed_button_flags());
// Reset the active mouse view before sending mouse released. That way if it
// calls back to us, we aren't in a weird state.
active_mouse_view_tracker_->SetView(nullptr);
active_mouse_view->OnMouseReleased(release_event);
}
void MenuController::SendMouseCaptureLostToActiveView() {
View* active_mouse_view = active_mouse_view_tracker_->view();
if (!active_mouse_view) {
return;
}
// Reset the active mouse view before sending mouse capture lost. That way if
// it calls back to us, we aren't in a weird state.
active_mouse_view_tracker_->SetView(nullptr);
active_mouse_view->OnMouseCaptureLost();
}
void MenuController::SetExitType(ExitType type) {
exit_type_ = type;
}
void MenuController::ExitMenu() {
bool nested = delegate_stack_.size() > 1;
// ExitTopMostMenu unwinds nested delegates
internal::MenuControllerDelegate* delegate = delegate_;
int accept_event_flags = accept_event_flags_;
base::WeakPtr<MenuController> this_ref = AsWeakPtr();
MenuItemView* result = ExitTopMostMenu();
delegate->OnMenuClosed(internal::MenuControllerDelegate::NOTIFY_DELEGATE,
result, accept_event_flags);
// |delegate| may have deleted this.
if (this_ref && nested && exit_type_ == ExitType::kAll) {
ExitMenu();
}
}
MenuItemView* MenuController::ExitTopMostMenu() {
// Release the lock which prevents Chrome from shutting down while the menu is
// showing.
base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE,
base::BindOnce(&ViewsDelegate::ReleaseRef,
base::Unretained(ViewsDelegate::GetInstance())));
// Close any open menus.
SetSelection(nullptr, SELECTION_UPDATE_IMMEDIATELY | SELECTION_EXIT);
#if BUILDFLAG(IS_WIN)
// On Windows, if we select the menu item by touch and if the window at the
// location is another window on the same thread, that window gets a
// WM_MOUSEACTIVATE message and ends up activating itself, which is not
// correct. We workaround this by setting a property on the window at the
// current cursor location. We check for this property in our
// WM_MOUSEACTIVATE handler and don't activate the window if the property is
// set.
if (item_selected_by_touch_) {
item_selected_by_touch_ = false;
POINT cursor_pos;
::GetCursorPos(&cursor_pos);
HWND window = ::WindowFromPoint(cursor_pos);
if (::GetWindowThreadProcessId(window, nullptr) == ::GetCurrentThreadId()) {
::SetProp(window, ui::kIgnoreTouchMouseActivateForWindow,
reinterpret_cast<HANDLE>(true));
}
}
#endif
std::unique_ptr<MenuButtonController::PressedLock> nested_pressed_lock;
bool nested_menu = !menu_stack_.empty();
if (nested_menu) {
DCHECK(!menu_stack_.empty());
// We're running from within a menu, restore the previous state.
// The menus are already showing, so we don't have to show them.
state_ = menu_stack_.back().first;
pending_state_ = menu_stack_.back().first;
hot_button_ = state_.hot_button;
nested_pressed_lock = std::move(menu_stack_.back().second);
menu_stack_.pop_back();
// Even though the menus are nested, there may not be nested delegates.
if (delegate_stack_.size() > 1) {
delegate_stack_.pop_back();
delegate_ = delegate_stack_.back().get();
}
} else {
#if defined(USE_AURA)
menu_pre_target_handler_.reset();
#endif
showing_ = false;
did_capture_ = false;
}
MenuItemView* result = result_;
// In case we're nested, reset |result_|.
result_ = nullptr;
if (exit_type_ == ExitType::kOutermost) {
SetExitType(ExitType::kNone);
} else if (nested_menu && result) {
// We're nested and about to return a value. The caller might enter
// another blocking loop. We need to make sure all menus are hidden
// before that happens otherwise the menus will stay on screen.
CloseAllNestedMenus();
SetSelection(nullptr, SELECTION_UPDATE_IMMEDIATELY | SELECTION_EXIT);
// Set exit_all_, which makes sure all nested loops exit immediately.
if (exit_type_ != ExitType::kDestroyed) {
SetExitType(ExitType::kAll);
}
}
// Reset our pressed lock and hot-tracked state to the previous state's, if
// they were active. The lock handles the case if the button was destroyed.
pressed_lock_ = std::move(nested_pressed_lock);
if (hot_button_) {
hot_button_->SetHotTracked(true);
}
return result;
}
void MenuController::HandleMouseLocation(SubmenuView* source,
const gfx::Point& mouse_location) {
if (showing_submenu_) {
return;
}
// Ignore mouse events if we're closing the menu.
if (exit_type_ != ExitType::kNone) {
return;
}
MenuPart part = GetMenuPart(source, mouse_location);
UpdateScrolling(part);
if (for_drop_) {
return;
}
if (part.type == MenuPartType::kNone &&
ShowSiblingMenu(source, mouse_location)) {
return;
}
if (part.type == MenuPartType::kMenuItem && part.menu) {
SetSelection(part.menu, part.should_submenu_show ? SELECTION_OPEN_SUBMENU
: SELECTION_DEFAULT);
} else if (!part.is_scroll() && pending_state_.item &&
pending_state_.item->GetParentMenuItem() &&
!pending_state_.item->SubmenuIsShowing()) {
// On exit if the user hasn't selected an item with a submenu, move the
// selection back to the parent menu item.
SetSelection(pending_state_.item->GetParentMenuItem(),
SELECTION_OPEN_SUBMENU);
}
}
void MenuController::SetInitialHotTrackedView(
MenuItemView* item,
SelectionIncrementDirectionType direction) {
if (!item) {
return;
}
SetSelection(item, SELECTION_DEFAULT);
View* hot_view =
GetInitialFocusableView(item, direction == INCREMENT_SELECTION_DOWN);
SetHotTrackedButton(Button::AsButton(hot_view));
}
void MenuController::SetNextHotTrackedView(
MenuItemView* item,
SelectionIncrementDirectionType direction) {
MenuItemView* parent = item->GetParentMenuItem();
if (!parent) {
return;
}
const auto menu_items = parent->GetSubmenu()->GetMenuItems();
const size_t num_menu_items = menu_items.size();
if (num_menu_items <= 1) {
return;
}
const auto i = std::ranges::find(menu_items, item);
DCHECK(i != menu_items.cend());
auto index = static_cast<size_t>(std::distance(menu_items.cbegin(), i));
// Loop through the menu items in the desired direction. Assume we can wrap
// all the way back to this item.
size_t stop_index = index;
if (!MenuConfig::instance().arrow_key_selection_wraps) {
// Don't want to allow wrapping, so stop as soon as it happens.
stop_index = direction == INCREMENT_SELECTION_UP ? (num_menu_items - 1) : 0;
}
const size_t delta =
direction == INCREMENT_SELECTION_UP ? (num_menu_items - 1) : 1;
while (true) {
index = (index + delta) % num_menu_items;
if (index == stop_index) {
return;
}
// Stop on the next keyboard-traversable item.
MenuItemView* child = parent->GetSubmenu()->GetMenuItemAt(index);
if (child->IsTraversableByKeyboard()) {
SetInitialHotTrackedView(child, direction);
return;
}
}
}
void MenuController::SetHotTrackedButton(Button* new_hot_button) {
// Set hot tracked state and fire a11y events for the hot tracked button.
// This must be done whether or not it was the previous hot tracked button.
// For example, when a zoom button is pressed, the menu remains open and the
// same zoom button should have its hot tracked state set again.
// If we're providing a new hot-tracked button, first remove the existing one.
if (hot_button_ && hot_button_ != new_hot_button) {
hot_button_->SetHotTracked(false);
hot_button_->GetViewAccessibility().EndPopupFocusOverride();
}
// Then set the new one.
hot_button_ = new_hot_button;
if (hot_button_) {
hot_button_->GetViewAccessibility().SetPopupFocusOverride();
hot_button_->SetHotTracked(true);
hot_button_->NotifyAccessibilityEventDeprecated(
ax::mojom::Event::kSelection, true);
}
}
bool MenuController::ShouldContinuePrefixSelection() const {
MenuItemView* item = pending_state_.item;
if (!item->SubmenuIsShowing()) {
item = item->GetParentMenuItem();
}
return item->GetSubmenu()->GetPrefixSelector()->ShouldContinueSelection();
}
void MenuController::RegisterAlertedItem(MenuItemView* item) {
alerted_items_.insert(item);
// Start animation if necessary. We stop the animation once no alerted
// items are showing.
if (!alert_animation_.is_animating()) {
alert_animation_.SetThrobDuration(kAlertAnimationThrobDuration);
alert_animation_.StartThrobbing(-1);
}
}
void MenuController::UnregisterAlertedItem(MenuItemView* item) {
alerted_items_.erase(item);
// Stop animation if necessary.
if (alerted_items_.empty()) {
alert_animation_.Stop();
}
}
void MenuController::SetAnchorParametersForItem(MenuItemView* item,
const gfx::Point& item_loc,
ui::OwnedWindowAnchor* anchor) {
if (item->GetParentMenuItem()) {
anchor->anchor_position = ui::OwnedWindowAnchorPosition::kTopRight;
anchor->anchor_gravity = ui::OwnedWindowAnchorGravity::kBottomRight;
// If the parent item has been repositioned to the left of its parent
// item. The next items must also be positioned on the left of its parent.
// Otherwise, there will be a chain of menus that will be positioned as to
// the right, to the left, to the right, to the left, etc. The direction
// must be maintained.
if (item->GetParentMenuItem()->GetParentMenuItem()) {
gfx::Point parent_of_parent_item_loc;
View::ConvertPointToScreen(item->GetParentMenuItem(),
&parent_of_parent_item_loc);
if (parent_of_parent_item_loc.x() > item_loc.x()) {
anchor->anchor_position = ui::OwnedWindowAnchorPosition::kTopLeft;
anchor->anchor_gravity = ui::OwnedWindowAnchorGravity::kBottomLeft;
}
}
anchor->constraint_adjustment =
ui::OwnedWindowConstraintAdjustment::kAdjustmentSlideY |
ui::OwnedWindowConstraintAdjustment::kAdjustmentFlipX |
ui::OwnedWindowConstraintAdjustment::kAdjustmentResizeX |
ui::OwnedWindowConstraintAdjustment::kAdjustmentRezizeY;
} else {
if (IsContextMenu()) {
anchor->anchor_position = ui::OwnedWindowAnchorPosition::kBottomLeft;
anchor->anchor_gravity = ui::OwnedWindowAnchorGravity::kBottomRight;
anchor->constraint_adjustment =
ui::OwnedWindowConstraintAdjustment::kAdjustmentSlideX |
ui::OwnedWindowConstraintAdjustment::kAdjustmentFlipY |
ui::OwnedWindowConstraintAdjustment::kAdjustmentRezizeY;
} else {
anchor->constraint_adjustment =
ui::OwnedWindowConstraintAdjustment::kAdjustmentSlideX |
ui::OwnedWindowConstraintAdjustment::kAdjustmentFlipY |
ui::OwnedWindowConstraintAdjustment::kAdjustmentRezizeY;
if (state_.anchor == MenuAnchorPosition::kTopRight) {
anchor->anchor_position = ui::OwnedWindowAnchorPosition::kBottomRight;
anchor->anchor_gravity = ui::OwnedWindowAnchorGravity::kBottomLeft;
} else {
anchor->anchor_position = ui::OwnedWindowAnchorPosition::kBottomLeft;
anchor->anchor_gravity = ui::OwnedWindowAnchorGravity::kBottomRight;
}
}
}
}
base::CallbackListSubscription MenuController::AddAnnotationCallback(
AnnotationCallback callback) {
return annotation_callbacks_.Add(base::BindRepeating(
[](AnnotationCallback callback, bool& result,
const ui::LocatedEvent& event) {
if (result) {
// A different annotation has already handled this event.
return;
}
result = callback.Run(event);
},
std::move(callback)));
}
bool MenuController::MaybeForwardToAnnotation(SubmenuView* source,
const ui::LocatedEvent& event) {
const std::unique_ptr<ui::Event> cloned = event.Clone();
auto* located = static_cast<ui::LocatedEvent*>(cloned.get());
const gfx::Point screen_loc = View::ConvertPointToScreen(
source->GetScrollViewContainer(), event.location());
located->set_root_location(screen_loc);
bool result = false;
annotation_callbacks_.Notify(result, *located);
return result;
}
bool MenuController::CanProcessInputEvents() const {
#if BUILDFLAG(IS_MAC)
return !menu_closure_animation_;
#else
return true;
#endif
}
MenuController::MenuOpenDirection
MenuController::GetChildMenuOpenDirectionAtDepth(size_t depth) const {
const size_t index = depth - 1;
return index >= child_menu_open_direction_.size()
? MenuOpenDirection::kLeading
: child_menu_open_direction_.at(index);
}
void MenuController::SetChildMenuOpenDirectionAtDepth(
size_t depth,
MenuOpenDirection direction) {
const size_t index = depth - 1;
if (index == child_menu_open_direction_.size()) {
child_menu_open_direction_.push_back(direction);
} else if (index < child_menu_open_direction_.size()) {
child_menu_open_direction_[index] = direction;
} else {
NOTREACHED();
}
}
void MenuController::SetMenuRoundedCorners(
std::optional<gfx::RoundedCornersF> corners) {
rounded_corners_ = corners;
}
} // namespace views