Implement the final UI for the CAPS LOCK indicator (part 3 of 3)

chrome/browser/chromeos/status/caps_lock_menu_button.cc

 // Copyright (c) 2011 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 "chrome/browser/chromeos/status/caps_lock_menu_button.h"
 
 #include <string>
 
 #include "base/utf_string_conversions.h"
 #include "chrome/browser/chromeos/input_method/xkeyboard.h"
+#include "chrome/browser/chromeos/system/runtime_environment.h"
 #include "chrome/browser/prefs/pref_service.h"
 #include "chrome/browser/profiles/profile.h"
+#include "chrome/browser/ui/views/bubble/bubble.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "chrome/common/pref_names.h"
 #include "grit/generated_resources.h"
 #include "grit/theme_resources.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/resource/resource_bundle.h"
 #include "ui/gfx/canvas.h"
 #include "ui/gfx/canvas_skia.h"
 #include "ui/gfx/font.h"
 #include "views/controls/menu/menu_item_view.h"
 #include "views/controls/menu/menu_runner.h"
 #include "views/controls/menu/submenu_view.h"
 #include "views/widget/widget.h"
 
 namespace {
 
 // Spacing between lines of text.
 const int kSpacing = 3;
 // Width and height of the image.
 const int kImageWidth = 22, kImageHeight = 21;
 // Constants for status displayed when user clicks button.
 // Padding around status.
 const int kPadLeftX = 10, kPadRightX = 10, kPadY = 5;
 // Padding between image and text.
 const int kTextPadX = 10;
 
+const size_t kMaxBubbleCount = 3;
+const size_t kCloseBubbleTimerInSec = 5;
+
 // Returns PrefService object associated with |host|.
 PrefService* GetPrefService(chromeos::StatusAreaHost* host) {
   if (host->GetProfile())
     return host->GetProfile()->GetPrefs();
   return NULL;
 }
 
 }  // namespace
 
 namespace chromeos {
 
 class CapsLockMenuButton::StatusView : public View {
  public:
   explicit StatusView(CapsLockMenuButton* menu_button)
       : menu_button_(menu_button),
         font_(ResourceBundle::GetSharedInstance().GetFont(
             ResourceBundle::BaseFont)) {
   }
 
   virtual ~StatusView() {
   }
 
-  gfx::Size GetPreferredSize() {
+  virtual gfx::Size GetPreferredSize() OVERRIDE {
     // TODO(yusukes): For better string localization, we should use either
     // IDS_STATUSBAR_CAPS_LOCK_ENABLED_PRESS_SHIFT_KEYS or
     // IDS_STATUSBAR_CAPS_LOCK_ENABLED_PRESS_SEARCH here instead of just
     // concatenating IDS_STATUSBAR_CAPS_LOCK_ENABLED and GetText(). Find a good
     // way to break the long text into lines and stop concatenating strings.
     const string16 first_line_text = l10n_util::GetStringUTF16(
         IDS_STATUSBAR_CAPS_LOCK_ENABLED);
     const string16 second_line_text = menu_button_->GetText();
 
     int first_line_width = 0;
@@ skipping 43 matching lines @@
                           text_x, second_line_text_y,
                           width() - text_x, text_height,
                           gfx::Canvas::TEXT_ALIGN_LEFT);
   }
 
   bool OnMousePressed(const views::MouseEvent& event) {
     return true;
   }
 
   void OnMouseReleased(const views::MouseEvent& event) {
-    if (event.IsLeftMouseButton()) {
-      DCHECK(menu_button_->menu_runner_.get());
-      menu_button_->menu_runner_->Cancel();
-    }
+    if (!event.IsLeftMouseButton())

[Zachary Kuznia, 2011/10/18 08:09:10]

Is there a reason the right mouse button shouldn't close the bubble, too?

[Yusuke Sato, 2011/10/18 08:42:46]

I chose the same behavior as PowerButton.

On 2011/10/18 08:09:10, Zachary Kuznia wrote:

+      return;
+    if (menu_button_->IsMenuShown())
+      menu_button_->HideMenu();
+    if (menu_button_->IsBubbleShown())
+      menu_button_->HideBubble();
   }
 
  private:
   CapsLockMenuButton* menu_button_;
   gfx::Font font_;
 
   DISALLOW_COPY_AND_ASSIGN(StatusView);
 };
 
 ////////////////////////////////////////////////////////////////////////////////
 // CapsLockMenuButton
 
 CapsLockMenuButton::CapsLockMenuButton(StatusAreaHost* host)
     : StatusAreaButton(host, this),
       prefs_(GetPrefService(host)),
-      status_(NULL) {
+      status_(NULL),
+      bubble_(NULL),
+      should_show_bubble_(true),
+      bubble_count_(0) {
   if (prefs_)
     remap_search_key_to_.Init(
         prefs::kLanguageXkbRemapSearchKeyTo, prefs_, this);
 
   SetIcon(*ResourceBundle::GetSharedInstance().GetBitmapNamed(
       IDR_STATUSBAR_CAPS_LOCK));
   UpdateAccessibleName();
   UpdateUIFromCurrentCapsLock(input_method::XKeyboard::CapsLockIsEnabled());
   if (SystemKeyEventListener::GetInstance())
     SystemKeyEventListener::GetInstance()->AddCapsLockObserver(this);
@@ skipping 18 matching lines @@
   return string16();
 }
 
 bool CapsLockMenuButton::IsCommandEnabled(int id) const {
   return false;
 }
 
 void CapsLockMenuButton::RunMenu(views::View* source, const gfx::Point& pt) {
   static const int kDummyCommandId = 1000;
 
+  if (IsBubbleShown())
+    HideBubble();
+
   views::MenuItemView* menu = new views::MenuItemView(this);
   // MenuRunner takes ownership of |menu|.
   menu_runner_.reset(new views::MenuRunner(menu));
   views::MenuItemView* submenu = menu->AppendMenuItem(
       kDummyCommandId,
       L"",
       views::MenuItemView::NORMAL);
   status_ = new CapsLockMenuButton::StatusView(this);
   submenu->AddChildView(status_);
   menu->CreateSubmenu()->set_resize_open_menu(true);
@@ skipping 10 matching lines @@
       views::MenuRunner::MENU_DELETED)
     return;
   status_ = NULL;
   menu_runner_.reset(NULL);
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // SystemKeyEventListener::CapsLockObserver implementation
 
 void CapsLockMenuButton::OnCapsLockChange(bool enabled) {
+  if (!enabled && !HasCapsLock() && bubble_count_ > 0) {
+    // Both shift keys are pressed. We can assume that the user now recognizes
+    // how to turn off Caps Lock.
+    should_show_bubble_ = false;
+  }
+
+  // Update the indicator.
   UpdateUIFromCurrentCapsLock(enabled);
+
+  // Update the drop-down menu and bubble. Since the constructor also calls
+  // UpdateUIFromCurrentCapsLock, we shouldn't do this in the function.
+  if (enabled && IsMenuShown())

[Zachary Kuznia, 2011/10/18 08:09:10]

Are multiple statements here expected to be true?  If not, I think it would be
more clear if these were else if blocks.

[Yusuke Sato, 2011/10/18 08:42:46]

Done.

+    status_->Update();  // Update the drop-down menu if it's already shown.
+  if (!enabled && IsMenuShown())
+    HideMenu();
+  if (enabled)
+    MaybeShowBubble();
+  if (!enabled && IsBubbleShown())
+    HideBubble();
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // NotificationObserver implementation
 
 void CapsLockMenuButton::Observe(int type,
                                  const NotificationSource& source,
                                  const NotificationDetails& details) {
   if (type == chrome::NOTIFICATION_PREF_CHANGED)
     UpdateAccessibleName();
 }
 
 void CapsLockMenuButton::UpdateAccessibleName() {
   int id = IDS_STATUSBAR_CAPS_LOCK_ENABLED_PRESS_SHIFT_KEYS;
-  if (prefs_ && (remap_search_key_to_.GetValue() == input_method::kCapsLockKey))
+  if (HasCapsLock())
     id = IDS_STATUSBAR_CAPS_LOCK_ENABLED_PRESS_SEARCH;
   SetAccessibleName(l10n_util::GetStringUTF16(id));
 }
 
 string16 CapsLockMenuButton::GetText() const {
   int id = IDS_STATUSBAR_PRESS_SHIFT_KEYS;
-  if (prefs_ && (remap_search_key_to_.GetValue() == input_method::kCapsLockKey))
+  if (HasCapsLock())
     id = IDS_STATUSBAR_PRESS_SEARCH;
   return l10n_util::GetStringUTF16(id);
 }
 
 void CapsLockMenuButton::UpdateUIFromCurrentCapsLock(bool enabled) {
   SetVisible(enabled);
   SchedulePaint();
-  if (enabled && status_)
-    status_->Update();
-  if (!enabled && menu_runner_.get())
-    menu_runner_->Cancel();
+}
+
+bool CapsLockMenuButton::IsMenuShown() const {
+  return menu_runner_.get() && status_;
+}
+
+void CapsLockMenuButton::HideMenu() {
+  if (!IsMenuShown())
+    return;
+  menu_runner_->Cancel();
+}
+
+bool CapsLockMenuButton::IsBubbleShown() const {
+  return bubble_;
+}
+
+void CapsLockMenuButton::MaybeShowBubble() {
+  if (IsBubbleShown() ||
+      // We've already shown the bubble |kMaxBubbleCount| times.
+      !should_show_bubble_ ||
+      // Don't show the bubble when Caps Lock key is available.
+      HasCapsLock())
+    return;
+
+  ++bubble_count_;
+  if (bubble_count_ > kMaxBubbleCount) {
+    should_show_bubble_ = false;
+  } else {
+    CreateAndShowBubble();
+    bubble_timer_.Start(FROM_HERE,
+                        base::TimeDelta::FromSeconds(kCloseBubbleTimerInSec),
+                        this,
+                        &CapsLockMenuButton::HideBubble);
+  }
+}
+
+void CapsLockMenuButton::CreateAndShowBubble() {
+  if (IsBubbleShown()) {
+    LOG(ERROR) << "The bubble UI is already created";

[Zachary Kuznia, 2011/10/18 08:09:10]

Should this be NOTREACHED()?

[Yusuke Sato, 2011/10/18 08:42:46]

Done.

+    return;
+  }
+
+  gfx::Rect button_bounds = GetScreenBounds();
+  button_bounds.set_y(button_bounds.y() + 1);  // See login/message_bubble.cc.
+
+  bubble_ = Bubble::ShowFocusless(GetWidget(),
+                                  button_bounds,
+                                  views::BubbleBorder::TOP_RIGHT,
+                                  new CapsLockMenuButton::StatusView(this),
+                                  NULL /* no delegate */,
+                                  true /* show_while_screen_is_locked */);
+}
+
+void CapsLockMenuButton::HideBubble() {
+  if (!IsBubbleShown())
+    return;
+  bubble_timer_.Stop(); // no-op if it's not running.

[Zachary Kuznia, 2011/10/18 08:09:10]

nit: Two spaces between ; and //

[Yusuke Sato, 2011/10/18 08:42:46]

Done.

+  bubble_->Close();
+  bubble_ = NULL;
+}
+
+bool CapsLockMenuButton::HasCapsLock() const {
+  return (prefs_ &&
+          (remap_search_key_to_.GetValue() == input_method::kCapsLockKey)) ||
+      // A keyboard for Linux usually has Caps Lock.
+      !system::runtime_environment::IsRunningOnChromeOS();
 }
 
 }  // namespace chromeos