Support for showing/hiding status area volume controls in desktop devices

chrome/browser/chromeos/status/volume_menu_button.cc

 // Copyright (c) 2012 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/volume_menu_button.h"
 
 #include <algorithm>
 
+#include "base/command_line.h"
 #include "base/string_number_conversions.h"
-#include "chrome/browser/chromeos/audio/audio_handler.h"
 #include "chrome/browser/chromeos/status/status_area_bubble.h"
 #include "chrome/browser/chromeos/view_ids.h"
+#include "chrome/common/chrome_switches.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/image/image.h"
 #include "ui/views/controls/menu/menu_item_view.h"
 #include "ui/views/controls/menu/menu_runner.h"
 #include "ui/views/controls/menu/submenu_view.h"
 
+namespace chromeos {
+
 namespace {
 
 static const int kMenuItemId = 100;  // arbitrary menu id.

[Daniel Erat, 2012/01/27 18:03:57]

nit: don't need static on globals that are in an anonymous namespace

[achuithb, 2012/01/31 00:58:43]

Done.

 // TODO(achuith): Minimum width of MenuItemView is 27, which is too wide.
 static const int kVolumeMenuWidth = 27;
 static const int kVolumeIconWidth = 20;
 
+bool ShouldShowStatusAreaVolume() {
+  return CommandLine::ForCurrentProcess()->
+      HasSwitch(switches::kShowVolumeStatus);
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 // AudioHandler helpers
 
 // Used when not running on a ChromeOS device.
 static int g_volume_percent = 0;
 
-chromeos::AudioHandler* GetAudioHandler() {
-  chromeos::AudioHandler* audio_handler = chromeos::AudioHandler::GetInstance();
-  return audio_handler && audio_handler->IsInitialized() ?
-      audio_handler : NULL;
-}
-
 int GetVolumePercent() {
-  chromeos::AudioHandler* audio_handler = GetAudioHandler();
-  return audio_handler ? audio_handler->GetVolumePercent() : g_volume_percent;
+  AudioHandler* audio_handler = AudioHandler::GetInstanceIfInitialized();
+  if (audio_handler)
+    return audio_handler->IsMuted() ? 0 : audio_handler->GetVolumePercent();
+  return g_volume_percent;
 }
 
 void SetVolumePercent(int percent) {
-  chromeos::AudioHandler* audio_handler = GetAudioHandler();
+  AudioHandler* audio_handler = AudioHandler::GetInstanceIfInitialized();
   if (audio_handler)
     audio_handler->SetVolumePercent(percent);
   g_volume_percent = percent;
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // SkBitmap helpers
 
 const SkBitmap* GetImageNamed(int image_index) {
   return ResourceBundle::GetSharedInstance().
@@ skipping 10 matching lines @@
     image_index = IDR_STATUSBAR_VOLUME_ICON2;
   else if (volume_percent > 0)
     image_index = IDR_STATUSBAR_VOLUME_ICON1;
 
   return GetImageNamed(image_index);
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // VolumeControlView
 
-class VolumeControlView : public views::View {
+class VolumeControlView : public views::View,
+                          public AudioHandler::VolumeObserver {

[stevenjb, 2012/01/27 19:45:02]

Technically this is dual inheritance; in particular this will have two
constructors.

It doesn't look like this needs to be a VolumeObserver; all that
OnVolumeChanged() does is call SchedulePaint; since VolumeControlView is a
non-widget child of VolumeMenuButton, it seems it would just end up calling
SchedulePaintInRect() on its parent anyway, so can't we just have
VolumeMenuButton call ScedulePaint() in its observer?

[achuithb, 2012/01/31 00:58:43]

I'll reverse my decision to put code in the ctor of VolumeObserver.

SchedulePaint in VolumeMenuButton::OnVolumeChanged() doesn't repaint
VolumeControlView, and I don't know enough about our Views subsystem to know
why.

  public:
-  explicit VolumeControlView(chromeos::VolumeMenuButton* volume_menu_button);
+  explicit VolumeControlView(VolumeMenuButton* volume_menu_button);
 
  private:
   // views::View overrides:
   virtual gfx::Size GetPreferredSize() OVERRIDE;
   virtual void OnPaint(gfx::Canvas* canvas) OVERRIDE;
   virtual bool OnMousePressed(const views::MouseEvent& event) OVERRIDE;
   virtual bool OnMouseDragged(const views::MouseEvent& event) OVERRIDE;
 
-  chromeos::VolumeMenuButton* volume_menu_button_;
+  // AudioHandler::VolumeObserver overrides:
+  virtual void OnVolumeChanged() OVERRIDE;
+
+  VolumeMenuButton* volume_menu_button_;
 
   const SkBitmap* slider_empty_;
   const SkBitmap* slider_full_;
   const SkBitmap* thumb_;
 
   int slider_w_;
   int slider_h_;
   int thumb_h_;
 
   DISALLOW_COPY_AND_ASSIGN(VolumeControlView);
 };
 
 VolumeControlView::VolumeControlView(
-    chromeos::VolumeMenuButton* volume_menu_button)
+    VolumeMenuButton* volume_menu_button)
     : volume_menu_button_(volume_menu_button),
       slider_empty_(GetImageNamed(IDR_STATUSBAR_VOLUME_SLIDER_EMPTY)),
       slider_full_(GetImageNamed(IDR_STATUSBAR_VOLUME_SLIDER_FULL)),
       thumb_(GetImageNamed(IDR_STATUSBAR_VOLUME_SLIDER_THUMB)),
       slider_w_(slider_empty_->width()),
       slider_h_(slider_empty_->height()),
       thumb_h_(thumb_->height()) {
   DCHECK_EQ(slider_w_, slider_full_->width());
 }
 
@@ skipping 38 matching lines @@
   const int new_volume = 100 - (std::max(std::min((event.y() - slider_empty_y),
       slider_h_), 0) * 100 / slider_h_);
   if (new_volume != GetVolumePercent()) {
     SetVolumePercent(new_volume);
     SchedulePaint();
     volume_menu_button_->UpdateIcon();
   }
   return true;
 }
 
+void VolumeControlView::OnVolumeChanged() {
+  SchedulePaint();
+}
+
 }  // namespace
 
-namespace chromeos {
-
 ////////////////////////////////////////////////////////////////////////////////
 // VolumeMenuButton
 
 VolumeMenuButton::VolumeMenuButton(StatusAreaButton::Delegate* delegate)
     : StatusAreaButton(delegate, this) {
   set_id(VIEW_ID_STATUS_BUTTON_VOLUME);
   UpdateIcon();
-  // TODO(achuith): Query SystemKeyEventListener to determine when we
-  // can show statusbar volume controls.
-  SetVisible(false);
+  SetVisible(ShouldShowStatusAreaVolume());
 }
 
 VolumeMenuButton::~VolumeMenuButton() {
 }
 
 int VolumeMenuButton::icon_width() {
   return kVolumeIconWidth;
 }
 
 void VolumeMenuButton::UpdateIcon() {
   const int volume_percent = GetVolumePercent();
   string16 tooltip_text = (volume_percent == 0)
       ? l10n_util::GetStringUTF16(IDS_STATUSBAR_VOLUME_MUTE)
       : l10n_util::GetStringFUTF16(IDS_STATUSBAR_VOLUME_PERCENTAGE,
                                    base::IntToString16(volume_percent));
   SetTooltipText(tooltip_text);
   SetAccessibleName(tooltip_text);
 
   SetIcon(*GetIcon());
   SchedulePaint();
 }
 
 void VolumeMenuButton::OnLocaleChanged() {
   UpdateIcon();
 }
 
+void VolumeMenuButton::OnVolumeChanged() {
+  UpdateIcon();
+}
+
 void VolumeMenuButton::RunMenu(views::View* source, const gfx::Point& pt) {
   // TODO(achuith): Minimum width of MenuItemView is 27 pix which is too wide
   // for our purposes here.
   views::MenuItemView* menu = new views::MenuItemView(this);
   // MenuRunner takes ownership of |menu|.
   views::MenuRunner* menu_runner = new views::MenuRunner(menu);
   views::MenuItemView* submenu = menu->AppendMenuItem(
       kMenuItemId,
       string16(),
       views::MenuItemView::NORMAL);
@@ skipping 13 matching lines @@
       this,
       bounds,
       views::MenuItemView::TOPRIGHT,
       views::MenuRunner::HAS_MNEMONICS);
 
   if (result != views::MenuRunner::MENU_DELETED)
     delete menu_runner;
 }
 
 }  // namespace chromeos