menu_button.h revision 5d1f7b1de12d16ceb2c938c56701a3e8bfa558f7
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) 105e3f23d412006dc4db4e659864679f29341e113fTorne (Richard Coles)#include "base/strings/string16.h" 11eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "base/time/time.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/views/background.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/views/controls/button/text_button.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace views { 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MenuButtonListener; 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//////////////////////////////////////////////////////////////////////////////// 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// MenuButton 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A button that shows a menu when the left mouse button is pushed 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//////////////////////////////////////////////////////////////////////////////// 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class VIEWS_EXPORT MenuButton : public TextButton { 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char kViewClassName[]; 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // How much padding to put on the left and right of the menu marker. 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const int kMenuMarkerPaddingLeft; 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const int kMenuMarkerPaddingRight; 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Create a Button. 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuButton(ButtonListener* listener, 365d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const base::string16& text, 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuButtonListener* menu_button_listener, 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool show_menu_marker); 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~MenuButton(); 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool show_menu_marker() const { return show_menu_marker_; } 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_menu_marker(const gfx::ImageSkia* menu_marker) { 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) menu_marker_ = menu_marker; 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::ImageSkia* menu_marker() const { return menu_marker_; } 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::Point& menu_offset() const { return menu_offset_; } 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_menu_offset(int x, int y) { menu_offset_.SetPoint(x, y); } 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Activate the button (called when the button is pressed). 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool Activate(); 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden from TextButton for the potential use of a drop marker. 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void PaintButton(gfx::Canvas* canvas, PaintButtonMode mode) OVERRIDE; 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden from View: 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual gfx::Size GetPreferredSize() OVERRIDE; 58b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) virtual const char* GetClassName() const OVERRIDE; 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnMousePressed(const ui::MouseEvent& event) OVERRIDE; 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnMouseReleased(const ui::MouseEvent& event) OVERRIDE; 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnMouseExited(const ui::MouseEvent& event) OVERRIDE; 622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnGestureEvent(ui::GestureEvent* event) OVERRIDE; 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnKeyPressed(const ui::KeyEvent& event) OVERRIDE; 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnKeyReleased(const ui::KeyEvent& event) OVERRIDE; 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void GetAccessibleState(ui::AccessibleViewState* state) OVERRIDE; 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 684e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // Paint the menu marker image. 694e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) void PaintMenuMarker(gfx::Canvas* canvas); 704e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // True if the menu is currently visible. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool menu_visible_; 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Offset of the associated menu position. 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) gfx::Point menu_offset_; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class TextButtonBackground; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Compute the maximum X coordinate for the current screen. MenuButtons 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // use this to make sure a menu is never shown off screen. 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int GetMaximumScreenXCoordinate(); 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We use a time object in order to keep track of when the menu was closed. 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The time is used for simulating menu behavior for the menu button; that 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // is, if the menu is shown and the button is pressed, we need to close the 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // menu. There is no clean way to get the second click event because the 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // menu is displayed using a modal loop and, unlike regular menus in Windows, 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the button is not part of the displayed menu. 90f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) base::TimeTicks menu_closed_time_; 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Our listener. Not owned. 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuButtonListener* listener_; 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Whether or not we're showing a drop marker. 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool show_menu_marker_; 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The down arrow used to differentiate the menu button from normal 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // text buttons. 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::ImageSkia* menu_marker_; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If non-null the destuctor sets this to true. This is set while the menu is 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // showing and used to detect if the menu was deleted while running. 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool* destroyed_flag_; 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(MenuButton); 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace views 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // UI_VIEWS_CONTROLS_BUTTON_MENU_BUTTON_H_ 112