172a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen// Copyright (c) 2011 The Chromium Authors. All rights reserved. 2c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Use of this source code is governed by a BSD-style license that can be 3c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// found in the LICENSE file. 4c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 572a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen#ifndef CHROME_BROWSER_UI_GTK_MENU_GTK_H_ 672a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen#define CHROME_BROWSER_UI_GTK_MENU_GTK_H_ 73345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#pragma once 8c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 9c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include <gtk/gtk.h> 10c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 11c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include <string> 12c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include <vector> 13c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 14c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "base/task.h" 1572a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen#include "ui/base/gtk/gtk_signal.h" 1672a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen#include "ui/gfx/point.h" 17c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 18c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass SkBitmap; 19c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 2072a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsennamespace ui { 21c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass ButtonMenuItemModel; 22c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass MenuModel; 23c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch} 24c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 25c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass MenuGtk { 26c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch public: 27c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Delegate class that lets another class control the status of the menu. 28c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch class Delegate { 29c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch public: 30ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen virtual ~Delegate() {} 31c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 32c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Called before a command is executed. This exists for the case where a 33c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // model is handling the actual execution of commands, but the delegate 34c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // still needs to know that some command got executed. This is called before 35c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // and not after the command is executed because its execution may delete 36c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // the menu and/or the delegate. 37c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual void CommandWillBeExecuted() {} 38c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 39c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Called when the menu stops showing. This will be called before 40c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // ExecuteCommand if the user clicks an item, but will also be called when 41c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // the user clicks away from the menu. 42c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual void StoppedShowing() {} 43c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 44c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Return true if we should override the "gtk-menu-images" system setting 45c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // when showing image menu items for this menu. 46731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick virtual bool AlwaysShowIconForCmd(int command_id) const { return false; } 47c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 48c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns a tinted image used in button in a menu. 49c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual GtkIconSet* GetIconSetForId(int idr) { return NULL; } 50731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick 51731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick // Returns an icon for the menu item, if available. 52731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick virtual GtkWidget* GetImageForCommandId(int command_id) const; 53731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick 54731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick static GtkWidget* GetDefaultImageForCommandId(int command_id); 55c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch }; 56c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 5772a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen MenuGtk(MenuGtk::Delegate* delegate, ui::MenuModel* model); 58c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ~MenuGtk(); 59c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 60c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Initialize GTK signal handlers. 61c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch void ConnectSignalHandlers(); 62c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 63c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // These methods are used to build the menu dynamically. The return value 64c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // is the new menu item. 65c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch GtkWidget* AppendMenuItemWithLabel(int command_id, const std::string& label); 66c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch GtkWidget* AppendMenuItemWithIcon(int command_id, const std::string& label, 67c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch const SkBitmap& icon); 68c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch GtkWidget* AppendCheckMenuItemWithLabel(int command_id, 69c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch const std::string& label); 70c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch GtkWidget* AppendSeparator(); 71c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch GtkWidget* AppendMenuItem(int command_id, GtkWidget* menu_item); 723345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick GtkWidget* AppendMenuItemToMenu(int index, 7372a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen ui::MenuModel* model, 74c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch GtkWidget* menu_item, 75c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch GtkWidget* menu, 76c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool connect_to_activate); 77c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 7872a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // Displays the menu near a widget, as if the widget were a menu bar. 7972a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // Example: the wrench menu button. 8072a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // |button| is the mouse button that brought up the menu. 8172a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // |event_time| is the time from the GdkEvent. 8272a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen void PopupForWidget(GtkWidget* widget, int button, guint32 event_time); 83c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 8472a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // Displays the menu as a context menu, i.e. at the cursor location. 8572a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // It is implicit that it was brought up using the right mouse button. 8672a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // |point| is the point where to put the menu. 87c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // |event_time| is the time of the event that triggered the menu's display. 8872a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen void PopupAsContext(const gfx::Point& point, guint32 event_time); 89c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 903345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // Displays the menu as a context menu for the passed status icon. 913345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick void PopupAsContextForStatusIcon(guint32 event_time, guint32 button, 923345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick GtkStatusIcon* icon); 933345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 94c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Displays the menu following a keyboard event (such as selecting |widget| 95c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // and pressing "enter"). 96c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch void PopupAsFromKeyEvent(GtkWidget* widget); 97c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 98c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Closes the menu. 99c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch void Cancel(); 100c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 101c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Repositions the menu to be right under the button. Alignment is set as 102c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // object data on |void_widget| with the tag "left_align". If "left_align" 103c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // is true, it aligns the left side of the menu with the left side of the 104c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // button. Otherwise it aligns the right side of the menu with the right side 105c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // of the button. Public since some menus have odd requirements that don't 106c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // belong in a public class. 107c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static void WidgetMenuPositionFunc(GtkMenu* menu, 108c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch int* x, 109c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch int* y, 110c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch gboolean* push_in, 111c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch void* void_widget); 112c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 113c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Positions the menu to appear at the gfx::Point represented by |userdata|. 114c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static void PointMenuPositionFunc(GtkMenu* menu, 115c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch int* x, 116c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch int* y, 117c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch gboolean* push_in, 118c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch gpointer userdata); 119c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 120c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch GtkWidget* widget() const { return menu_; } 121c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 1223345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // Updates all the enabled/checked states and the dynamic labels. 1233345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick void UpdateMenu(); 1243345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 125c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch private: 126c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Builds a GtkImageMenuItem. 127c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch GtkWidget* BuildMenuItemWithImage(const std::string& label, 128c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch const SkBitmap& icon); 129c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 130731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick GtkWidget* BuildMenuItemWithImage(const std::string& label, 131731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick GtkWidget* image); 132731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick 133731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick GtkWidget* BuildMenuItemWithLabel(const std::string& label, 134731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick int command_id); 135731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick 136c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // A function that creates a GtkMenu from |model_|. 137c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch void BuildMenuFromModel(); 138c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Implementation of the above; called recursively. 13972a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen void BuildSubmenuFromModel(ui::MenuModel* model, GtkWidget* menu); 140c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Builds a menu item with buttons in it from the data in the model. 141dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen GtkWidget* BuildButtonMenuItem(ui::ButtonMenuItemModel* model, 142c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch GtkWidget* menu); 143c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 14472a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen void ExecuteCommand(ui::MenuModel* model, int id); 145c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 146c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Callback for when a menu item is clicked. 1473345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick CHROMEGTK_CALLBACK_0(MenuGtk, void, OnMenuItemActivated); 148c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 149c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Called when one of the buttons are pressed. 1503345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick CHROMEGTK_CALLBACK_1(MenuGtk, void, OnMenuButtonPressed, int); 151c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 1523345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // Called to maybe activate a button if that button isn't supposed to dismiss 1533345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // the menu. 1543345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick CHROMEGTK_CALLBACK_1(MenuGtk, gboolean, OnMenuTryButtonPressed, int); 155c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 156c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Updates all the menu items' state. 1573345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick CHROMEGTK_CALLBACK_0(MenuGtk, void, OnMenuShow); 158c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 159c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Sets the activating widget back to a normal appearance. 1603345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick CHROMEGTK_CALLBACK_0(MenuGtk, void, OnMenuHidden); 1613345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 1623345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // Sets the enable/disabled state and dynamic labels on our menu items. 1633345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick static void SetButtonItemInfo(GtkWidget* button, gpointer userdata); 1643345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick 1653345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // Sets the check mark, enabled/disabled state and dynamic labels on our menu 1663345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick // items. 1673345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick static void SetMenuItemInfo(GtkWidget* widget, void* raw_menu); 168c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 169c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Queries this object about the menu state. 170c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch MenuGtk::Delegate* delegate_; 171c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 172c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // If non-NULL, the MenuModel that we use to populate and control the GTK 173c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // menu (overriding the delegate as a controller). 17472a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen ui::MenuModel* model_; 175c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 176c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // For some menu items, we want to show the accelerator, but not actually 177c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // explicitly handle it. To this end we connect those menu items' accelerators 178c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // to this group, but don't attach this group to any top level window. 179c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch GtkAccelGroup* dummy_accel_group_; 180c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 181c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // gtk_menu_popup() does not appear to take ownership of popup menus, so 182c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // MenuGtk explicitly manages the lifetime of the menu. 183c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch GtkWidget* menu_; 184c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 185c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // True when we should ignore "activate" signals. Used to prevent 186c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // menu items from getting activated when we are setting up the 187c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // menu. 188c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static bool block_activation_; 189c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 190c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // We must free these at shutdown. 191c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch std::vector<MenuGtk*> submenus_we_own_; 192c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 193c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ScopedRunnableMethodFactory<MenuGtk> factory_; 194c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch}; 195c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 19672a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen#endif // CHROME_BROWSER_UI_GTK_MENU_GTK_H_ 197