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 5731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick#ifndef CHROME_BROWSER_CHROMEOS_STATUS_INPUT_METHOD_MENU_H_ 6731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick#define CHROME_BROWSER_CHROMEOS_STATUS_INPUT_METHOD_MENU_H_ 73345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#pragma once 8c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 921d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen#include <string> 1021d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 11c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "chrome/browser/chromeos/cros/input_method_library.h" 1272a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen#include "chrome/browser/chromeos/status/status_area_host.h" 133345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#include "chrome/browser/prefs/pref_member.h" 14dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#include "content/common/notification_observer.h" 15dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#include "content/common/notification_registrar.h" 16dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#include "content/common/notification_type.h" 1772a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen#include "ui/base/models/simple_menu_model.h" 18c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "views/controls/menu/menu_2.h" 19c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "views/controls/menu/view_menu_delegate.h" 20c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 21731df977c0511bca2206b5f333555b1205ff1f43Iain Merrickclass PrefService; 22c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass SkBitmap; 23c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 24c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochnamespace chromeos { 25c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 26731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick// A class for the dropdown menu for switching input method and keyboard layout. 27731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick// Since the class provides the views::ViewMenuDelegate interface, it's easy to 28731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick// create a button widget (e.g. views::MenuButton, chromeos::StatusAreaButton) 29731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick// which shows the dropdown menu on click. 30731df977c0511bca2206b5f333555b1205ff1f43Iain Merrickclass InputMethodMenu : public views::ViewMenuDelegate, 3172a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen public ui::MenuModel, 32731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick public InputMethodLibrary::Observer, 33731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick public NotificationObserver { 34c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch public: 35731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick InputMethodMenu(PrefService* pref_service, 3672a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen StatusAreaHost::ScreenMode screen_mode, 3772a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen bool for_out_of_box_experience_dialog); 38731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick virtual ~InputMethodMenu(); 39c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 4072a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // ui::MenuModel implementation. 41c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual bool HasIcons() const; 42c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual int GetItemCount() const; 4372a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen virtual ui::MenuModel::ItemType GetTypeAt(int index) const; 44c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual int GetCommandIdAt(int index) const; 45c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual string16 GetLabelAt(int index) const; 4621d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen virtual bool IsItemDynamicAt(int index) const; 47c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual bool GetAcceleratorAt(int index, 4872a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen ui::Accelerator* accelerator) const; 49c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual bool IsItemCheckedAt(int index) const; 50c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual int GetGroupIdAt(int index) const; 51ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen virtual bool GetIconAt(int index, SkBitmap* icon); 5272a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen virtual ui::ButtonMenuItemModel* GetButtonMenuItemAt(int index) const; 53c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual bool IsEnabledAt(int index) const; 5472a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen virtual ui::MenuModel* GetSubmenuModelAt(int index) const; 55c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual void HighlightChangedTo(int index); 56c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual void ActivatedAt(int index); 57c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual void MenuWillShow(); 58ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen virtual void SetMenuModelDelegate(ui::MenuModelDelegate* delegate); 59c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 60731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick // views::ViewMenuDelegate implementation. Sub classes can override the method 61731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick // to adjust the position of the menu. 62731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick virtual void RunMenu(views::View* unused_source, 63731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick const gfx::Point& pt); 64731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick 65c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // InputMethodLibrary::Observer implementation. 6621d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen virtual void InputMethodChanged( 6721d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen InputMethodLibrary* obj, 6821d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen const InputMethodDescriptor& current_input_method, 6921d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen size_t num_active_input_methods); 7021d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen virtual void ActiveInputMethodsChanged( 7121d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen InputMethodLibrary* obj, 7221d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen const InputMethodDescriptor& current_input_method, 7321d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen size_t num_active_input_methods); 7421d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen virtual void PreferenceUpdateNeeded( 7521d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen InputMethodLibrary* obj, 7621d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen const InputMethodDescriptor& previous_input_method, 7721d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen const InputMethodDescriptor& current_input_method); 78ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen virtual void PropertyListChanged( 79ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen InputMethodLibrary* obj, 80ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen const ImePropertyList& current_ime_properties); 8172a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen virtual void FirstObserverIsAdded(InputMethodLibrary* obj); 82c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 83c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // NotificationObserver implementation. 84c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual void Observe(NotificationType type, 85c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch const NotificationSource& source, 86c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch const NotificationDetails& details); 87c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 88731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick // Sets the minimum width of the dropdown menu. 89731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick void SetMinimumWidth(int width); 90731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick 91ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen // Rebuilds model and menu2 objects. 92ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen void PrepareMenu(); 93ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen 94731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick // Registers input method preferences for the login screen. 95731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick static void RegisterPrefs(PrefService* local_state); 96731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick 97731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick // Returns a string for the indicator on top right corner of the Chrome 98731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick // window. The method is public for unit tests. 99c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static std::wstring GetTextForIndicator( 100c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch const InputMethodDescriptor& input_method); 101c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 102c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns a string for the drop-down menu and the tooltip for the indicator. 103731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick // The method is public for unit tests. 1043345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick static std::wstring GetTextForMenu(const InputMethodDescriptor& input_method); 105c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 106c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch protected: 10772a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // Prepares menu: saves user metrics and rebuilds. 108731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick void PrepareForMenuOpen(); 109731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick 110731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick // Returns menu2 object for language menu. 111513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch views::Menu2& input_method_menu() { 112513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch return input_method_menu_; 113731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick } 114c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 115c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch private: 116731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick // Updates UI of a container of the menu (e.g. the "US" menu button in the 117731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick // status area). Sub classes have to implement the interface for their own UI. 11821d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen virtual void UpdateUI(const std::string& input_method_id, // e.g. "mozc" 11921d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen const std::wstring& name, // e.g. "US", "INTL" 12021d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen const std::wstring& tooltip, 12121d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen size_t num_active_input_methods) = 0; 122c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 123731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick // Sub classes have to implement the interface. This interface should return 124731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick // true if the dropdown menu should show an item like "Customize languages 12572a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // and input..." WebUI. 126731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick virtual bool ShouldSupportConfigUI() = 0; 127c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 128731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick // Sub classes have to implement the interface which opens an UI for 129731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick // customizing languages and input. 130731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick virtual void OpenConfigUI() = 0; 131c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 13272a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // Parses |input_method| and then calls UpdateUI(). 13372a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen void UpdateUIFromInputMethod(const InputMethodDescriptor& input_method, 13472a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen size_t num_active_input_methods); 13572a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen 136c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Rebuilds |model_|. This function should be called whenever 137c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // |input_method_descriptors_| is updated, or ImePropertiesChanged() is 138c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // called. 139c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch void RebuildModel(); 140c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 141c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns true if the zero-origin |index| points to one of the input methods. 142c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool IndexIsInInputMethodList(int index) const; 143c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 144c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns true if the zero-origin |index| points to one of the IME 145c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // properties. When returning true, |property_index| is updated so that 146c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // property_list.at(property_index) points to the menu item. 147c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool GetPropertyIndex(int index, int* property_index) const; 148c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 149c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Returns true if the zero-origin |index| points to the "Configure IME" menu 150c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // item. 151c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool IndexPointsToConfigureImeMenuItem(int index) const; 152c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 153c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // The current input method list. 154c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch scoped_ptr<InputMethodDescriptors> input_method_descriptors_; 155c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 156c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Objects for reading/writing the Chrome prefs. 157c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch StringPrefMember previous_input_method_pref_; 158c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch StringPrefMember current_input_method_pref_; 159c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 16072a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // We borrow ui::SimpleMenuModel implementation to maintain the current 16172a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // content of the pop-up menu. The ui::MenuModel is implemented using this 162c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // |model_|. 16372a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen scoped_ptr<ui::SimpleMenuModel> model_; 164c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 165c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // The language menu which pops up when the button in status area is clicked. 166513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch views::Menu2 input_method_menu_; 167513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch int minimum_input_method_menu_width_; 168c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 169731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick PrefService* pref_service_; 170c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch NotificationRegistrar registrar_; 17172a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen 17272a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // The mode of the host screen (e.g. browser, screen locker, login screen.) 17372a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen const StatusAreaHost::ScreenMode screen_mode_; 17472a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // true if the menu is for a dialog in OOBE screen. In the dialog, we don't 17572a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // use radio buttons. 17672a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen const bool for_out_of_box_experience_dialog_; 177c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 178731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick DISALLOW_COPY_AND_ASSIGN(InputMethodMenu); 179c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch}; 180c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 181c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch} // namespace chromeos 182c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 183731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick#endif // CHROME_BROWSER_CHROMEOS_STATUS_INPUT_METHOD_MENU_H_ 184