menu_controller.h revision 7d4cd473f85ac64c3747c96c277f9e506a0d2246
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef UI_VIEWS_CONTROLS_MENU_MENU_CONTROLLER_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UI_VIEWS_CONTROLS_MENU_MENU_CONTROLLER_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "build/build_config.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <list> 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <set> 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/message_loop.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/timer.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/base/events/event_constants.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/views/controls/menu/menu_delegate.h" 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/views/controls/menu/menu_item_view.h" 212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "ui/views/widget/widget_observer.h" 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace ui { 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NativeTheme; 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class OSExchangeData; 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace gfx { 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Screen; 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace views { 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MenuButton; 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MenuHostRootView; 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MouseEvent; 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class SubmenuView; 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class View; 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace internal { 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MenuControllerDelegate; 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MenuRunnerImpl; 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// MenuController ------------------------------------------------------------- 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// MenuController is used internally by the various menu classes to manage 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// showing, selecting and drag/drop for menus. All relevant events are 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// forwarded to the MenuController from SubmenuView and MenuHost. 48c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)class VIEWS_EXPORT MenuController : public base::MessageLoop::Dispatcher, 492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) public WidgetObserver { 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Enumeration of how the menu should exit. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum ExitType { 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Don't exit. 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) EXIT_NONE, 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // All menus, including nested, should be exited. 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) EXIT_ALL, 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Only the outermost menu should be exited. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) EXIT_OUTERMOST, 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This is set if the menu is being closed as the result of one of the menus 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // being destroyed. 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) EXIT_DESTROYED 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If a menu is currently active, this returns the controller for it. 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static MenuController* GetActiveInstance(); 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Runs the menu at the specified location. If the menu was configured to 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // block, the selected item is returned. If the menu does not block this 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // returns NULL immediately. 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemView* Run(Widget* parent, 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuButton* button, 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemView* root, 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::Rect& bounds, 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemView::AnchorPosition position, 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool context_menu, 792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int* event_flags); 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Whether or not Run blocks. 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool IsBlockingRun() const { return blocking_run_; } 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Whether or not drag operation is in progress. 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool drag_in_progress() const { return drag_in_progress_; } 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Get the anchor position wich is used to show this menu. 882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) MenuItemView::AnchorPosition GetAnchorPosition() { return state_.anchor; } 892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Cancels the current Run. See ExitType for a description of what happens 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // with the various parameters. 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Cancel(ExitType type); 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // An alternative to Cancel(EXIT_ALL) that can be used with a OneShotTimer. 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CancelAll() { Cancel(EXIT_ALL); } 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the current exit type. This returns a value other than EXIT_NONE if 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the menu is being canceled. 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExitType exit_type() const { return exit_type_; } 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns the time from the event which closed the menu - or 0. 1022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) base::TimeDelta closing_event_time() const { return closing_event_time_; } 1032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Various events, forwarded from the submenu. 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NOTE: the coordinates of the events are in that of the 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // MenuScrollViewContainer. 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnMousePressed(SubmenuView* source, const ui::MouseEvent& event); 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnMouseDragged(SubmenuView* source, const ui::MouseEvent& event); 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnMouseReleased(SubmenuView* source, const ui::MouseEvent& event); 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnMouseMoved(SubmenuView* source, const ui::MouseEvent& event); 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnMouseEntered(SubmenuView* source, const ui::MouseEvent& event); 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_LINUX) 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool OnMouseWheel(SubmenuView* source, const ui::MouseWheelEvent& event); 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void OnGestureEvent(SubmenuView* source, ui::GestureEvent* event); 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool GetDropFormats( 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SubmenuView* source, 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int* formats, 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::set<ui::OSExchangeData::CustomFormat>* custom_formats); 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AreDropTypesRequired(SubmenuView* source); 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool CanDrop(SubmenuView* source, const ui::OSExchangeData& data); 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnDragEntered(SubmenuView* source, const ui::DropTargetEvent& event); 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int OnDragUpdated(SubmenuView* source, const ui::DropTargetEvent& event); 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnDragExited(SubmenuView* source); 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int OnPerformDrop(SubmenuView* source, const ui::DropTargetEvent& event); 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Invoked from the scroll buttons of the MenuScrollViewContainer. 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnDragEnteredScrollButton(SubmenuView* source, bool is_up); 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnDragExitedScrollButton(SubmenuView* source); 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Update the submenu's selection based on the current mouse location 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void UpdateSubmenuSelection(SubmenuView* source); 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // WidgetObserver overrides: 1372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnWidgetDestroying(Widget* widget) OVERRIDE; 1382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 139c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Only used for testing. 140c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) static void TurnOffContextMenuSelectionHoldForTest(); 141c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class internal::MenuRunnerImpl; 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class MenuHostRootView; 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class MenuItemView; 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class SubmenuView; 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class MenuScrollTask; 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct SelectByCharDetails; 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Values supplied to SetSelection. 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum SetSelectionTypes { 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SELECTION_DEFAULT = 0, 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If set submenus are opened immediately, otherwise submenus are only 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // openned after a timer fires. 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SELECTION_UPDATE_IMMEDIATELY = 1 << 0, 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If set and the menu_item has a submenu, the submenu is shown. 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SELECTION_OPEN_SUBMENU = 1 << 1, 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // SetSelection is being invoked as the result exiting or cancelling the 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // menu. This is used for debugging. 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SELECTION_EXIT = 1 << 2, 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Result type for SendAcceleratorToHotTrackedView 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum SendAcceleratorResultType { 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Accelerator is not sent because of no hot tracked views. 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ACCELERATOR_NOT_PROCESSED, 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Accelerator is sent to the hot tracked views. 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ACCELERATOR_PROCESSED, 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Same as above and the accelerator causes the exit of the menu. 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ACCELERATOR_PROCESSED_EXIT 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Tracks selection information. 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct State { 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) State(); 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~State(); 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The selected menu item. 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemView* item; 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If item has a submenu this indicates if the submenu is showing. 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool submenu_open; 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Bounds passed to the run menu. Used for positioning the first menu. 1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) gfx::Rect initial_bounds; 1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Position of the initial menu. 1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemView::AnchorPosition anchor; 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The direction child menus have opened in. 1985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::list<bool> open_leading; 1995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Bounds for the monitor we're showing on. 2015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) gfx::Rect monitor_bounds; 2025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Is the current menu a context menu. 2045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool context_menu; 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 2065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Used by GetMenuPart to indicate the menu part at a particular location. 2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct MenuPart { 2095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Type of part. 2105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum Type { 2115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NONE, 2125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MENU_ITEM, 2135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SCROLL_UP, 2145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SCROLL_DOWN 2155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 2165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuPart() : type(NONE), menu(NULL), parent(NULL), submenu(NULL) {} 2185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Convenience for testing type == SCROLL_DOWN or type == SCROLL_UP. 2205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_scroll() const { return type == SCROLL_DOWN || type == SCROLL_UP; } 2215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Type of part. 2235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Type type; 2245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If type is MENU_ITEM, this is the menu item the mouse is over, otherwise 2265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // this is NULL. 2275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NOTE: if type is MENU_ITEM and the mouse is not over a valid menu item 2285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // but is over a menu (for example, the mouse is over a separator or 2295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // empty menu), this is NULL and parent is the menu the mouse was 2305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // clicked on. 2315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemView* menu; 2325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If type is MENU_ITEM but the mouse is not over a menu item this is the 2345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // parent of the menu item the user clicked on. Otherwise this is NULL. 2355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemView* parent; 2365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This is the submenu the mouse is over. 2385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SubmenuView* submenu; 2395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 2405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Sets the selection to |menu_item|. A value of NULL unselects 2425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // everything. |types| is a bitmask of |SetSelectionTypes|. 2435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 2445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Internally this updates pending_state_ immediatley. state_ is only updated 2455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // immediately if SELECTION_UPDATE_IMMEDIATELY is set. If 2465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // SELECTION_UPDATE_IMMEDIATELY is not set CommitPendingSelection is invoked 2475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to show/hide submenus and update state_. 2485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetSelection(MenuItemView* menu_item, int types); 2495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetSelectionOnPointerDown(SubmenuView* source, 2515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ui::LocatedEvent& event); 2525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void StartDrag(SubmenuView* source, const gfx::Point& location); 2535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Dispatcher method. This returns true if the menu was canceled, or 2555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // if the message is such that the menu should be closed. 2565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool Dispatch(const base::NativeEvent& event) OVERRIDE; 2575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Key processing. The return value of this is returned from Dispatch. 2595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // In other words, if this returns false (which happens if escape was 2605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // pressed, or a matching mnemonic was found) the message loop returns. 2615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool OnKeyDown(ui::KeyboardCode key_code); 2625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a MenuController. If |blocking| is true a nested message loop is 2645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // started in |Run|. 2655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuController(ui::NativeTheme* theme, 2665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool blocking, 2675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) internal::MenuControllerDelegate* delegate); 2685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~MenuController(); 2705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Runs the platform specific bits of the message loop. If |nested_menu| is 2722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // true we're being asked to run a menu from within a menu (eg a context 2732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // menu). 2742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void RunMessageLoop(bool nested_menu); 2752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // AcceleratorPressed is invoked on the hot tracked view if it exists. 2775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SendAcceleratorResultType SendAcceleratorToHotTrackedView(); 2785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void UpdateInitialLocation(const gfx::Rect& bounds, 2805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemView::AnchorPosition position, 2815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool context_menu); 2825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Invoked when the user accepts the selected item. This is only used 2845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // when blocking. This schedules the loop to quit. 2852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void Accept(MenuItemView* item, int event_flags); 2865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ShowSiblingMenu(SubmenuView* source, const gfx::Point& mouse_location); 2885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Shows a context menu for |menu_item| as a result of a located event if 2905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // appropriate. This is invoked on long press and releasing the right mouse 2915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // button. Returns whether a context menu was shown. 2925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ShowContextMenu(MenuItemView* menu_item, 2935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SubmenuView* source, 2947d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) const ui::LocatedEvent& event, 2957d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) ui::MenuSourceType source_type); 2965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Closes all menus, including any menus of nested invocations of Run. 2985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CloseAllNestedMenus(); 2995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets the enabled menu item at the specified location. 3015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If over_any_menu is non-null it is set to indicate whether the location 3025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // is over any menu. It is possible for this to return NULL, but 3035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // over_any_menu to be true. For example, the user clicked on a separator. 3045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemView* GetMenuItemAt(View* menu, int x, int y); 3055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If there is an empty menu item at the specified location, it is returned. 3075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemView* GetEmptyMenuItemAt(View* source, int x, int y); 3085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if the coordinate is over the scroll buttons of the 3105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // SubmenuView's MenuScrollViewContainer. If true is returned, part is set to 3115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // indicate which scroll button the coordinate is. 3125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool IsScrollButtonAt(SubmenuView* source, 3135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int x, 3145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int y, 3155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuPart::Type* part); 3165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the target for the mouse event. The coordinates are in terms of 3185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // source's scroll view container. 3195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuPart GetMenuPart(SubmenuView* source, const gfx::Point& source_loc); 3205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the target for mouse events. The search is done through |item| and 3225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // all its parents. 3235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuPart GetMenuPartByScreenCoordinateUsingMenu(MenuItemView* item, 3245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::Point& screen_loc); 3255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Implementation of GetMenuPartByScreenCoordinate for a single menu. Returns 3275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // true if the supplied SubmenuView contains the location in terms of the 3285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // screen. If it does, part is set appropriately and true is returned. 3295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool GetMenuPartByScreenCoordinateImpl(SubmenuView* menu, 3305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::Point& screen_loc, 3315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuPart* part); 3325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if the SubmenuView contains the specified location. This does 3345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NOT included the scroll buttons, only the submenu view. 3355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool DoesSubmenuContainLocation(SubmenuView* submenu, 3365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::Point& screen_loc); 3375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Opens/Closes the necessary menus such that state_ matches that of 3395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // pending_state_. This is invoked if submenus are not opened immediately, 3405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // but after a delay. 3415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CommitPendingSelection(); 3425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If item has a submenu, it is closed. This does NOT update the selection 3445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in anyway. 3455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CloseMenu(MenuItemView* item); 3465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If item has a submenu, it is opened. This does NOT update the selection 3485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in anyway. 3495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OpenMenu(MenuItemView* item); 3505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Implementation of OpenMenu. If |show| is true, this invokes show on the 3525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // menu, otherwise Reposition is invoked. 3535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OpenMenuImpl(MenuItemView* item, bool show); 3545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Invoked when the children of a menu change and the menu is showing. 3565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This closes any submenus and resizes the submenu. 3575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void MenuChildrenChanged(MenuItemView* item); 3585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Builds the paths of the two menu items into the two paths, and 3605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // sets first_diff_at to the location of the first difference between the 3615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // two paths. 3625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void BuildPathsAndCalculateDiff(MenuItemView* old_item, 3635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemView* new_item, 3645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::vector<MenuItemView*>* old_path, 3655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::vector<MenuItemView*>* new_path, 3665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t* first_diff_at); 3675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Builds the path for the specified item. 3695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void BuildMenuItemPath(MenuItemView* item, std::vector<MenuItemView*>* path); 3705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Starts/stops the timer that commits the pending state to state 3725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // (opens/closes submenus). 3735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void StartShowTimer(); 3745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void StopShowTimer(); 3755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Starts/stops the timer cancel the menu. This is used during drag and 3775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // drop when the drop enters/exits the menu. 3785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void StartCancelAllTimer(); 3795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void StopCancelAllTimer(); 3805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Calculates the bounds of the menu to show. is_leading is set to match the 3825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // direction the menu opened in. 3835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) gfx::Rect CalculateMenuBounds(MenuItemView* item, 3845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool prefer_leading, 3855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool* is_leading); 3865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Calculates the bubble bounds of the menu to show. is_leading is set to 3882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // match the direction the menu opened in. 3892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) gfx::Rect CalculateBubbleMenuBounds(MenuItemView* item, 3902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool prefer_leading, 3912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool* is_leading); 3922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the depth of the menu. 3945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static int MenuDepth(MenuItemView* item); 3955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Selects the next/previous menu item. 3975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void IncrementSelection(int delta); 3985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the next selectable child menu item of |parent| starting at |index| 4005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and incrementing index by |delta|. If there are no more selected menu items 4015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NULL is returned. 4025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemView* FindNextSelectableMenuItem(MenuItemView* parent, 4035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int index, 4045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int delta); 4055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If the selected item has a submenu and it isn't currently open, the 4075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the selection is changed such that the menu opens immediately. 4085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OpenSubmenuChangeSelectionIfCan(); 4095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If possible, closes the submenu. 4115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CloseSubmenu(); 4125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns details about which menu items match the mnemonic |key|. 4145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |match_function| is used to determine which menus match. 4155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SelectByCharDetails FindChildForMnemonic( 4165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemView* parent, 4175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char16 key, 4185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool (*match_function)(MenuItemView* menu, char16 mnemonic)); 4195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Selects or accepts the appropriate menu item based on |details|. Returns 4215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // true if |Accept| was invoked (which happens if there aren't multiple item 4225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // with the same mnemonic and the item to select does not have a submenu). 4235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AcceptOrSelect(MenuItemView* parent, const SelectByCharDetails& details); 4245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Selects by mnemonic, and if that doesn't work tries the first character of 4265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the title. Returns true if a match was selected and the menu should exit. 4275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool SelectByChar(char16 key); 4285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // For Windows and Aura we repost an event for some events that dismiss 4302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // the context menu. The event is then reprocessed to cause its result 4312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // if the context menu had not been present. 4322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // On non-aura Windows, a new mouse event is generated and posted to 4332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // the window (if there is one) at the location of the event. On 4342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // aura, the event is reposted on the RootWindow. 4355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RepostEvent(SubmenuView* source, const ui::LocatedEvent& event); 4365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets the drop target to new_item. 4385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetDropMenuItem(MenuItemView* new_item, 4395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuDelegate::DropPosition position); 4405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Starts/stops scrolling as appropriate. part gives the part the mouse is 4425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // over. 4435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void UpdateScrolling(const MenuPart& part); 4445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Stops scrolling. 4465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void StopScrolling(); 4475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Updates |active_mouse_view_| from the location of the event and sends it 4495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the appropriate events. This is used to send mouse events to child views so 4505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // that they react to click-drag-release as if the user clicked on the view 4515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // itself. 4525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void UpdateActiveMouseView(SubmenuView* event_source, 4535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ui::MouseEvent& event, 4545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) View* target_menu); 4555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sends a mouse release event to the current |active_mouse_view_| and sets 4575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // it to null. 4585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SendMouseReleaseToActiveView(SubmenuView* event_source, 4595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ui::MouseEvent& event); 4605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sends a mouse capture lost event to the current |active_mouse_view_| and 4625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // sets it to null. 4635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SendMouseCaptureLostToActiveView(); 4645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets exit type. 4665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetExitType(ExitType type); 4675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns true if SetExitType() should quit the message loop. 4692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ShouldQuitNow() const; 4702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Handles the mouse location event on the submenu |source|. 4725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void HandleMouseLocation(SubmenuView* source, 4735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::Point& mouse_location); 4745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Retrieve an appropriate Screen. 4765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) gfx::Screen* GetScreen(); 4775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The active instance. 4795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static MenuController* active_instance_; 4805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If true, Run blocks. If false, Run doesn't block and this is used for 4825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // drag and drop. Note that the semantics for drag and drop are slightly 4835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // different: cancel timer is kicked off any time the drag moves outside the 4845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // menu, mouse events do nothing... 4855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool blocking_run_; 4865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If true, we're showing. 4885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool showing_; 4895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Indicates what to exit. 4915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExitType exit_type_; 4925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Whether we did a capture. We do a capture only if we're blocking and 4945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the mouse was down when Run. 4955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool did_capture_; 4965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // As the user drags the mouse around pending_state_ changes immediately. 4985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // When the user stops moving/dragging the mouse (or clicks the mouse) 4995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // pending_state_ is committed to state_, potentially resulting in 5005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // opening or closing submenus. This gives a slight delayed effect to 5015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // submenus as the user moves the mouse around. This is done so that as the 5025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // user moves the mouse all submenus don't immediately pop. 5035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) State pending_state_; 5045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) State state_; 5055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If the user accepted the selection, this is the result. 5075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemView* result_; 5085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5092a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // The event flags when the user selected the menu. 5102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int accept_event_flags_; 5115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If not empty, it means we're nested. When Run is invoked from within 5135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Run, the current state (state_) is pushed onto menu_stack_. This allows 5145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // MenuController to restore the state when the nested run returns. 5155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::list<State> menu_stack_; 5165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // As the mouse moves around submenus are not opened immediately. Instead 5185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // they open after this timer fires. 5195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::OneShotTimer<MenuController> show_timer_; 5205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Used to invoke CancelAll(). This is used during drag and drop to hide the 5225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // menu after the mouse moves out of the of the menu. This is necessitated by 5235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the lack of an ability to detect when the drag has completed from the drop 5245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // side. 5255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::OneShotTimer<MenuController> cancel_all_timer_; 5265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Drop target. 5285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemView* drop_target_; 5295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuDelegate::DropPosition drop_position_; 5305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Owner of child windows. 5325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // WARNING: this may be NULL. 5335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Widget* owner_; 5345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Indicates a possible drag operation. 5365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool possible_drag_; 5375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // True when drag operation is in progress. 5395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool drag_in_progress_; 5405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Location the mouse was pressed at. Used to detect d&d. 5425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) gfx::Point press_pt_; 5435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We get a slew of drag updated messages as the mouse is over us. To avoid 5455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // continually processing whether we can drop, we cache the coordinates. 5465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool valid_drop_coordinates_; 5475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) gfx::Point drop_pt_; 5485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int last_drop_operation_; 5495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If true, we're in the middle of invoking ShowAt on a submenu. 5515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool showing_submenu_; 5525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Task for scrolling the menu. If non-null indicates a scroll is currently 5545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // underway. 5555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<MenuScrollTask> scroll_task_; 5565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuButton* menu_button_; 5585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If non-null mouse drag events are forwarded to this view. See 5605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // UpdateActiveMouseView for details. 5615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) View* active_mouse_view_; 5625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) internal::MenuControllerDelegate* delegate_; 5645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // How deep we are in nested message loops. This should be at most 2 (when 5665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // showing a context menu from a menu). 5675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int message_loop_depth_; 5685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) views::MenuConfig menu_config_; 5705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // The timestamp of the event which closed the menu - or 0 otherwise. 5722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) base::TimeDelta closing_event_time_; 5732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 574c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Time when the menu is first shown. 575c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) base::TimeTicks menu_start_time_; 576c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 5775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(MenuController); 5785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 5795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace views 5815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // UI_VIEWS_CONTROLS_MENU_MENU_CONTROLLER_H_ 583