Hide handwriting and voice buttons when keyboard is in restricted state

ash/system/ime_menu/ime_menu_tray.cc

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "ash/system/ime_menu/ime_menu_tray.h"
 
 #include "ash/accelerators/accelerator_controller.h"
 #include "ash/accessibility_delegate.h"
 #include "ash/ash_constants.h"
 #include "ash/ime/ime_controller.h"
@@ skipping 158 matching lines @@
   // Settings button that is only used if the emoji, handwriting and voice
   // buttons are not available.
   SystemMenuButton* settings_button_;
 
   DISALLOW_COPY_AND_ASSIGN(ImeTitleView);
 };
 
 // The view that contains buttons shown on the bottom of IME menu.
 class ImeButtonsView : public views::View, public views::ButtonListener {
  public:
-  explicit ImeButtonsView(ImeMenuTray* ime_menu_tray)
-      : ime_menu_tray_(ime_menu_tray) {
+  explicit ImeButtonsView(ImeMenuTray* ime_menu_tray,

[James Cook, 2017/06/26 17:21:19]

nit: no explicit

[Azure Wei, 2017/06/27 14:27:14]

Done.

+                          bool show_emoji,
+                          bool show_handwriting,
+                          bool show_voice)
+      : ime_menu_tray_(ime_menu_tray),
+        show_emoji_(show_emoji),

[James Cook, 2017/06/26 17:21:19]

Do you need member variables for these? How about passing them as parameters to
the Init() method?

[Azure Wei, 2017/06/27 14:27:14]

These are unnecessary. Passed them with Init().

+        show_handwriting_(show_handwriting),
+        show_voice_(show_voice) {
     DCHECK(ime_menu_tray_);
 
     Init();
   }
 
   ~ImeButtonsView() override {}
 
   // views::ButtonListener:
   void ButtonPressed(views::Button* sender, const ui::Event& event) override {
     if (sender == settings_button_) {
@@ skipping 27 matching lines @@
     auto* box_layout = new views::BoxLayout(views::BoxLayout::kHorizontal);
     box_layout->set_minimum_cross_axis_size(kTrayPopupItemMinHeight);
     SetLayoutManager(box_layout);
     SetBorder(views::CreatePaddedBorder(
         views::CreateSolidSidedBorder(kSeparatorWidth, 0, 0, 0,
                                       kMenuSeparatorColor),
         gfx::Insets(kMenuSeparatorVerticalPadding - kSeparatorWidth,
                     kMenuExtraMarginFromLeftEdge)));
 
     const int right_border = 1;
-    emoji_button_ =
-        CreateImeMenuButton(this, kImeMenuEmoticonIcon,
-                            IDS_ASH_STATUS_TRAY_IME_EMOJI, right_border);
-    AddChildView(emoji_button_);
+    if (show_emoji_) {
+      emoji_button_ =
+          CreateImeMenuButton(this, kImeMenuEmoticonIcon,
+                              IDS_ASH_STATUS_TRAY_IME_EMOJI, right_border);
+      AddChildView(emoji_button_);
+    }
 
-    handwriting_button_ =
-        CreateImeMenuButton(this, kImeMenuWriteIcon,
-                            IDS_ASH_STATUS_TRAY_IME_HANDWRITING, right_border);
-    AddChildView(handwriting_button_);
+    if (show_handwriting_) {
+      handwriting_button_ = CreateImeMenuButton(
+          this, kImeMenuWriteIcon, IDS_ASH_STATUS_TRAY_IME_HANDWRITING,
+          right_border);
+      AddChildView(handwriting_button_);
+    }
 
-    voice_button_ =
-        CreateImeMenuButton(this, kImeMenuMicrophoneIcon,
-                            IDS_ASH_STATUS_TRAY_IME_VOICE, right_border);
-    AddChildView(voice_button_);
+    if (show_voice_) {
+      voice_button_ =
+          CreateImeMenuButton(this, kImeMenuMicrophoneIcon,
+                              IDS_ASH_STATUS_TRAY_IME_VOICE, right_border);
+      AddChildView(voice_button_);
+    }
 
     settings_button_ = CreateImeMenuButton(this, kSystemMenuSettingsIcon,
                                            IDS_ASH_STATUS_TRAY_IME_SETTINGS, 0);
     AddChildView(settings_button_);
     if (!TrayPopupUtils::CanOpenWebUISettings())
       settings_button_->SetEnabled(false);
   }
 
   ImeMenuTray* ime_menu_tray_;
+  bool show_emoji_;
+  bool show_handwriting_;
+  bool show_voice_;
   SystemMenuButton* emoji_button_;
   SystemMenuButton* handwriting_button_;
   SystemMenuButton* voice_button_;
   SystemMenuButton* settings_button_;
 
   DISALLOW_COPY_AND_ASSIGN(ImeButtonsView);
 };
 
 // A list of available IMEs shown in the opt-in IME menu, which has a different
 // height depending on the number of IMEs in the list.
@@ skipping 68 matching lines @@
   init_params.anchor_view = GetBubbleAnchor();
   init_params.anchor_alignment = GetAnchorAlignment();
   init_params.min_width = kTrayMenuMinimumWidth;
   init_params.max_width = kTrayMenuMinimumWidth;
   init_params.close_on_deactivate = true;
 
   views::TrayBubbleView* bubble_view = new views::TrayBubbleView(init_params);
   bubble_view->set_anchor_view_insets(GetBubbleAnchorInsets());
 
   // Add a title item with a separator on the top of the IME menu.
-  bubble_view->AddChildView(
-      new ImeTitleView(!ShouldShowEmojiHandwritingVoiceButtons()));
+  bool show_bottom_buttons, show_emoji, show_handwriting, show_voice;
+  show_bottom_buttons =
+      ShouldShowBottomButtons(show_emoji, show_handwriting, show_voice);
+  bubble_view->AddChildView(new ImeTitleView(!show_bottom_buttons));
 
   // Adds IME list to the bubble.
   ime_list_view_ = new ImeMenuListView(nullptr);
   ime_list_view_->Init(ShouldShowKeyboardToggle(),
                        ImeListView::SHOW_SINGLE_IME);
   bubble_view->AddChildView(ime_list_view_);
 
-  if (ShouldShowEmojiHandwritingVoiceButtons())
-    bubble_view->AddChildView(new ImeButtonsView(this));
+  if (show_bottom_buttons)
+    bubble_view->AddChildView(
+        new ImeButtonsView(this, show_emoji, show_handwriting, show_voice));
 
   bubble_.reset(new TrayBubbleWrapper(this, bubble_view));
   SetIsActive(true);
 }
 
 void ImeMenuTray::HideImeMenuBubble() {
   bubble_.reset();
   ime_list_view_ = nullptr;
   SetIsActive(false);
   shelf()->UpdateAutoHideState();
@@ skipping 37 matching lines @@
   // keyboard for one time.
   force_show_keyboard_ = true;
   accessibility_delegate->SetVirtualKeyboardEnabled(true);
   keyboard_controller = keyboard::KeyboardController::GetInstance();
   if (keyboard_controller) {
     keyboard_controller->AddObserver(this);
     keyboard_controller->ShowKeyboard(false);
   }
 }
 
-bool ImeMenuTray::ShouldShowEmojiHandwritingVoiceButtons() const {
+bool ImeMenuTray::ShouldShowBottomButtons(bool& emoji,
+                                          bool& handwriting,
+                                          bool& voice) const {
   // Emoji, handwriting and voice input is not supported for these cases:
   // 1) features::kEHVInputOnImeMenu is not enabled.
   // 2) third party IME extensions.
   // 3) login/lock screen.
   // 4) password input client.
-  return InputMethodManager::Get() &&
-         InputMethodManager::Get()->IsEmojiHandwritingVoiceOnImeMenuEnabled() &&
-         !ime_controller_->current_ime().third_party &&
-         !IsInLoginOrLockScreen() && !IsInPasswordInputContext();
+  InputMethodManager* input_method_manager = InputMethodManager::Get();
+  bool should_show_buttom_buttoms =
+      input_method_manager &&
+      input_method_manager->IsEmojiHandwritingVoiceOnImeMenuEnabled() &&
+      !ime_controller_->current_ime().third_party && !IsInLoginOrLockScreen() &&
+      !IsInPasswordInputContext();
+
+  if (!should_show_buttom_buttoms) {
+    emoji = handwriting = voice = false;
+    return false;
+  }
+
+  uint32_t features_restricted_state =
+      input_method_manager->GetFeaturesRestrictedState();

[James Cook, 2017/06/26 17:21:19]

Instead of having a global IsEmojiHandwritingVoiceOnImeMenuEnabled() followed by
"restricted features", how about just having 3 booleans like emoji-enabled,
handwriting-enabled and voice-enabled?

This could be something like GetImeMenuFeatures() that returns a bitmask or
individual GetFoo() methods.

[Azure Wei, 2017/06/27 14:27:14]

Done.

[James Cook, 2017/06/27 16:31:10]

This is not what I meant. See new comment on InputMethodManagerImpl.

+  emoji = !(features_restricted_state &
+            InputMethodManager::FeaturesRestrictedState::RESTRICTED_EMOJI);
+  handwriting =
+      !(features_restricted_state &
+        InputMethodManager::FeaturesRestrictedState::RESTRICTED_HANDWRITING);
+  voice = !(features_restricted_state &
+            InputMethodManager::FeaturesRestrictedState::RESTRICTED_VOICE);
+  return emoji || handwriting || voice;
 }
 
 bool ImeMenuTray::ShouldShowKeyboardToggle() const {
   return keyboard_suppressed_ &&
          !Shell::Get()->accessibility_delegate()->IsVirtualKeyboardEnabled();
 }
 
 base::string16 ImeMenuTray::GetAccessibleNameForTray() {
   return l10n_util::GetStringUTF16(IDS_ASH_IME_MENU_ACCESSIBLE_NAME);
 }
@@ skipping 130 matching lines @@
   else
     label_->SetText(current_ime.short_name);
 }
 
 void ImeMenuTray::DisableVirtualKeyboard() {
   Shell::Get()->accessibility_delegate()->SetVirtualKeyboardEnabled(false);
   force_show_keyboard_ = false;
 }
 
 }  // namespace ash