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_BUTTON_MENU_BUTTON_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UI_VIEWS_CONTROLS_BUTTON_MENU_BUTTON_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 101320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "base/memory/weak_ptr.h" 115e3f23d412006dc4db4e659864679f29341e113fTorne (Richard Coles)#include "base/strings/string16.h" 12eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "base/time/time.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/views/background.h" 14f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)#include "ui/views/controls/button/label_button.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace views { 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MenuButtonListener; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//////////////////////////////////////////////////////////////////////////////// 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// MenuButton 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A button that shows a menu when the left mouse button is pushed 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//////////////////////////////////////////////////////////////////////////////// 27f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)class VIEWS_EXPORT MenuButton : public LabelButton { 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 291320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // A scoped lock for keeping the MenuButton in STATE_PRESSED e.g., while a 301320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // menu is running. These are cumulative. 311320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci class VIEWS_EXPORT PressedLock { 321320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci public: 331320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci explicit PressedLock(MenuButton* menu_button); 341320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci ~PressedLock(); 351320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 361320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci private: 371320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci base::WeakPtr<MenuButton> menu_button_; 381320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 391320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci DISALLOW_COPY_AND_ASSIGN(PressedLock); 401320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci }; 411320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char kViewClassName[]; 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // How much padding to put on the left and right of the menu marker. 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const int kMenuMarkerPaddingLeft; 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const int kMenuMarkerPaddingRight; 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Create a Button. 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuButton(ButtonListener* listener, 505d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const base::string16& text, 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuButtonListener* menu_button_listener, 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool show_menu_marker); 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~MenuButton(); 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool show_menu_marker() const { return show_menu_marker_; } 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_menu_marker(const gfx::ImageSkia* menu_marker) { 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) menu_marker_ = menu_marker; 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::ImageSkia* menu_marker() const { return menu_marker_; } 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::Point& menu_offset() const { return menu_offset_; } 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_menu_offset(int x, int y) { menu_offset_.SetPoint(x, y); } 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Activate the button (called when the button is pressed). 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool Activate(); 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden from View: 68cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual gfx::Size GetPreferredSize() const OVERRIDE; 69b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) virtual const char* GetClassName() const OVERRIDE; 70f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) virtual void OnPaint(gfx::Canvas* canvas) OVERRIDE; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnMousePressed(const ui::MouseEvent& event) OVERRIDE; 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnMouseReleased(const ui::MouseEvent& event) OVERRIDE; 731320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci virtual void OnMouseEntered(const ui::MouseEvent& event) OVERRIDE; 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnMouseExited(const ui::MouseEvent& event) OVERRIDE; 751320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci virtual void OnMouseMoved(const ui::MouseEvent& event) OVERRIDE; 762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnGestureEvent(ui::GestureEvent* event) OVERRIDE; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnKeyPressed(const ui::KeyEvent& event) OVERRIDE; 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnKeyReleased(const ui::KeyEvent& event) OVERRIDE; 79a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) virtual void GetAccessibleState(ui::AXViewState* state) OVERRIDE; 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 824e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // Paint the menu marker image. 834e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) void PaintMenuMarker(gfx::Canvas* canvas); 844e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 85f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // Overridden from LabelButton: 86f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) virtual gfx::Rect GetChildAreaBounds() OVERRIDE; 87f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Offset of the associated menu position. 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) gfx::Point menu_offset_; 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 921320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci friend class PressedLock; 931320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 941320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // Increment/decrement the number of "pressed" locks this button has, and 951320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // set the state accordingly. 961320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci void IncrementPressedLocked(); 971320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci void DecrementPressedLocked(); 981320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Compute the maximum X coordinate for the current screen. MenuButtons 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // use this to make sure a menu is never shown off screen. 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int GetMaximumScreenXCoordinate(); 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We use a time object in order to keep track of when the menu was closed. 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The time is used for simulating menu behavior for the menu button; that 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // is, if the menu is shown and the button is pressed, we need to close the 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // menu. There is no clean way to get the second click event because the 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // menu is displayed using a modal loop and, unlike regular menus in Windows, 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the button is not part of the displayed menu. 109f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) base::TimeTicks menu_closed_time_; 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Our listener. Not owned. 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuButtonListener* listener_; 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Whether or not we're showing a drop marker. 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool show_menu_marker_; 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 117116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // The down arrow used to differentiate the menu button from normal buttons. 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::ImageSkia* menu_marker_; 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If non-null the destuctor sets this to true. This is set while the menu is 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // showing and used to detect if the menu was deleted while running. 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool* destroyed_flag_; 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1241320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // The current number of "pressed" locks this button has. 1251320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci int pressed_lock_count_; 1261320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 1271320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci base::WeakPtrFactory<MenuButton> weak_factory_; 1281320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(MenuButton); 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace views 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // UI_VIEWS_CONTROLS_BUTTON_MENU_BUTTON_H_ 135