tray_accessibility.cc revision effb81e5f8246d0db0270817048dc992db66e9fb 
1// Copyright (c) 2012 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#include "ash/system/tray_accessibility.h"
6
7#include "ash/accessibility_delegate.h"
8#include "ash/metrics/user_metrics_recorder.h"
9#include "ash/shell.h"
10#include "ash/system/tray/hover_highlight_view.h"
11#include "ash/system/tray/system_tray.h"
12#include "ash/system/tray/system_tray_delegate.h"
13#include "ash/system/tray/system_tray_notifier.h"
14#include "ash/system/tray/tray_constants.h"
15#include "ash/system/tray/tray_details_view.h"
16#include "ash/system/tray/tray_item_more.h"
17#include "ash/system/tray/tray_popup_label_button.h"
18#include "base/strings/utf_string_conversions.h"
19#include "grit/ash_resources.h"
20#include "grit/ash_strings.h"
21#include "ui/base/l10n/l10n_util.h"
22#include "ui/base/resource/resource_bundle.h"
23#include "ui/gfx/image/image.h"
24#include "ui/views/controls/image_view.h"
25#include "ui/views/controls/label.h"
26#include "ui/views/layout/box_layout.h"
27#include "ui/views/widget/widget.h"
28
29namespace ash {
30namespace internal {
31
32namespace {
33
34enum AccessibilityState {
35  A11Y_NONE = 0,
36  A11Y_SPOKEN_FEEDBACK = 1 << 0,
37  A11Y_HIGH_CONTRAST = 1 << 1,
38  A11Y_SCREEN_MAGNIFIER = 1 << 2,
39  A11Y_LARGE_CURSOR = 1 << 3,
40  A11Y_AUTOCLICK = 1 << 4,
41  A11Y_VIRTUAL_KEYBOARD = 1 << 5,
42  A11Y_BRAILLE_DISPLAY_CONNECTED = 1 << 6,
43};
44
45uint32 GetAccessibilityState() {
46  AccessibilityDelegate* delegate =
47      Shell::GetInstance()->accessibility_delegate();
48  uint32 state = A11Y_NONE;
49  if (delegate->IsSpokenFeedbackEnabled())
50    state |= A11Y_SPOKEN_FEEDBACK;
51  if (delegate->IsHighContrastEnabled())
52    state |= A11Y_HIGH_CONTRAST;
53  if (delegate->IsMagnifierEnabled())
54    state |= A11Y_SCREEN_MAGNIFIER;
55  if (delegate->IsLargeCursorEnabled())
56    state |= A11Y_LARGE_CURSOR;
57  if (delegate->IsAutoclickEnabled())
58    state |= A11Y_AUTOCLICK;
59  if (delegate->IsVirtualKeyboardEnabled())
60    state |= A11Y_VIRTUAL_KEYBOARD;
61  if (delegate->IsBrailleDisplayConnected())
62    state |= A11Y_BRAILLE_DISPLAY_CONNECTED;
63  return state;
64}
65
66user::LoginStatus GetCurrentLoginStatus() {
67  return Shell::GetInstance()->system_tray_delegate()->GetUserLoginStatus();
68}
69
70}  // namespace
71
72namespace tray {
73
74class DefaultAccessibilityView : public TrayItemMore {
75 public:
76  explicit DefaultAccessibilityView(SystemTrayItem* owner)
77      : TrayItemMore(owner, true) {
78    ui::ResourceBundle& bundle = ui::ResourceBundle::GetSharedInstance();
79    SetImage(bundle.GetImageNamed(IDR_AURA_UBER_TRAY_ACCESSIBILITY_DARK).
80                    ToImageSkia());
81    base::string16 label = bundle.GetLocalizedString(
82        IDS_ASH_STATUS_TRAY_ACCESSIBILITY);
83    SetLabel(label);
84    SetAccessibleName(label);
85  }
86
87  virtual ~DefaultAccessibilityView() {
88  }
89
90 private:
91  DISALLOW_COPY_AND_ASSIGN(DefaultAccessibilityView);
92};
93
94////////////////////////////////////////////////////////////////////////////////
95// ash::internal::tray::AccessibilityPopupView
96
97AccessibilityPopupView::AccessibilityPopupView(SystemTrayItem* owner,
98                                               uint32 enabled_state_bits)
99    : TrayNotificationView(owner, IDR_AURA_UBER_TRAY_ACCESSIBILITY_DARK),
100      label_(CreateLabel(enabled_state_bits)) {
101  InitView(label_);
102}
103
104views::Label* AccessibilityPopupView::CreateLabel(uint32 enabled_state_bits) {
105  DCHECK((enabled_state_bits &
106          (A11Y_SPOKEN_FEEDBACK | A11Y_BRAILLE_DISPLAY_CONNECTED)) != 0);
107  base::string16 text;
108  if (enabled_state_bits & A11Y_BRAILLE_DISPLAY_CONNECTED) {
109    text.append(l10n_util::GetStringUTF16(
110        IDS_ASH_STATUS_TRAY_BRAILLE_DISPLAY_CONNECTED_BUBBLE));
111  }
112  if (enabled_state_bits & A11Y_SPOKEN_FEEDBACK) {
113    if (!text.empty())
114      text.append(base::ASCIIToUTF16(" "));
115    text.append(l10n_util::GetStringUTF16(
116        IDS_ASH_STATUS_TRAY_SPOKEN_FEEDBACK_ENABLED_BUBBLE));
117  }
118  views::Label* label = new views::Label(text);
119  label->SetMultiLine(true);
120  label->SetHorizontalAlignment(gfx::ALIGN_LEFT);
121  return label;
122}
123
124////////////////////////////////////////////////////////////////////////////////
125// ash::internal::tray::AccessibilityDetailedView
126
127AccessibilityDetailedView::AccessibilityDetailedView(
128    SystemTrayItem* owner, user::LoginStatus login) :
129        TrayDetailsView(owner),
130        spoken_feedback_view_(NULL),
131        high_contrast_view_(NULL),
132        screen_magnifier_view_(NULL),
133        large_cursor_view_(NULL),
134        help_view_(NULL),
135        settings_view_(NULL),
136        autoclick_view_(NULL),
137        virtual_keyboard_view_(NULL),
138        spoken_feedback_enabled_(false),
139        high_contrast_enabled_(false),
140        screen_magnifier_enabled_(false),
141        large_cursor_enabled_(false),
142        autoclick_enabled_(false),
143        virtual_keyboard_enabled_(false),
144        login_(login) {
145
146  Reset();
147
148  AppendAccessibilityList();
149  AppendHelpEntries();
150  CreateSpecialRow(IDS_ASH_STATUS_TRAY_ACCESSIBILITY_TITLE, this);
151
152  Layout();
153}
154
155void AccessibilityDetailedView::AppendAccessibilityList() {
156  CreateScrollableList();
157  ui::ResourceBundle& bundle = ui::ResourceBundle::GetSharedInstance();
158
159  AccessibilityDelegate* delegate =
160      Shell::GetInstance()->accessibility_delegate();
161  spoken_feedback_enabled_ = delegate->IsSpokenFeedbackEnabled();
162  spoken_feedback_view_ = AddScrollListItem(
163      bundle.GetLocalizedString(
164          IDS_ASH_STATUS_TRAY_ACCESSIBILITY_SPOKEN_FEEDBACK),
165      spoken_feedback_enabled_ ? gfx::Font::BOLD : gfx::Font::NORMAL,
166      spoken_feedback_enabled_);
167
168  // Large Cursor item is shown only in Login screen.
169  if (login_ == user::LOGGED_IN_NONE) {
170    large_cursor_enabled_ = delegate->IsLargeCursorEnabled();
171    large_cursor_view_ = AddScrollListItem(
172        bundle.GetLocalizedString(
173            IDS_ASH_STATUS_TRAY_ACCESSIBILITY_LARGE_CURSOR),
174        large_cursor_enabled_ ? gfx::Font::BOLD : gfx::Font::NORMAL,
175        large_cursor_enabled_);
176  }
177
178  high_contrast_enabled_ = delegate->IsHighContrastEnabled();
179  high_contrast_view_ = AddScrollListItem(
180      bundle.GetLocalizedString(
181          IDS_ASH_STATUS_TRAY_ACCESSIBILITY_HIGH_CONTRAST_MODE),
182      high_contrast_enabled_ ? gfx::Font::BOLD : gfx::Font::NORMAL,
183      high_contrast_enabled_);
184  screen_magnifier_enabled_ = delegate->IsMagnifierEnabled();
185  screen_magnifier_view_ = AddScrollListItem(
186      bundle.GetLocalizedString(
187          IDS_ASH_STATUS_TRAY_ACCESSIBILITY_SCREEN_MAGNIFIER),
188      screen_magnifier_enabled_ ? gfx::Font::BOLD : gfx::Font::NORMAL,
189      screen_magnifier_enabled_);
190
191  // Don't show autoclick option at login screen.
192  if (login_ != user::LOGGED_IN_NONE) {
193    autoclick_enabled_ = delegate->IsAutoclickEnabled();
194    autoclick_view_ = AddScrollListItem(
195        bundle.GetLocalizedString(
196            IDS_ASH_STATUS_TRAY_ACCESSIBILITY_AUTOCLICK),
197        autoclick_enabled_ ? gfx::Font::BOLD : gfx::Font::NORMAL,
198        autoclick_enabled_);
199  }
200
201  virtual_keyboard_enabled_ = delegate->IsVirtualKeyboardEnabled();
202  virtual_keyboard_view_ =  AddScrollListItem(
203      bundle.GetLocalizedString(
204          IDS_ASH_STATUS_TRAY_ACCESSIBILITY_VIRTUAL_KEYBOARD),
205      virtual_keyboard_enabled_ ? gfx::Font::BOLD : gfx::Font::NORMAL,
206      virtual_keyboard_enabled_);
207}
208
209void AccessibilityDetailedView::AppendHelpEntries() {
210  // Currently the help page requires a browser window.
211  // TODO(yoshiki): show this even on login/lock screen. crbug.com/158286
212  if (login_ == user::LOGGED_IN_NONE ||
213      login_ == user::LOGGED_IN_LOCKED)
214    return;
215
216  views::View* bottom_row = new View();
217  views::BoxLayout* layout = new
218      views::BoxLayout(views::BoxLayout::kHorizontal,
219                       kTrayMenuBottomRowPadding,
220                       kTrayMenuBottomRowPadding,
221                       kTrayMenuBottomRowPaddingBetweenItems);
222  layout->set_spread_blank_space(true);
223  bottom_row->SetLayoutManager(layout);
224
225  ui::ResourceBundle& bundle = ui::ResourceBundle::GetSharedInstance();
226
227  TrayPopupLabelButton* help = new TrayPopupLabelButton(
228      this,
229      bundle.GetLocalizedString(
230          IDS_ASH_STATUS_TRAY_ACCESSIBILITY_LEARN_MORE));
231  bottom_row->AddChildView(help);
232  help_view_ = help;
233
234  TrayPopupLabelButton* settings = new TrayPopupLabelButton(
235      this,
236      bundle.GetLocalizedString(
237          IDS_ASH_STATUS_TRAY_ACCESSIBILITY_SETTINGS));
238  bottom_row->AddChildView(settings);
239  settings_view_ = settings;
240
241  AddChildView(bottom_row);
242}
243
244HoverHighlightView* AccessibilityDetailedView::AddScrollListItem(
245    const base::string16& text,
246    gfx::Font::FontStyle style,
247    bool checked) {
248  HoverHighlightView* container = new HoverHighlightView(this);
249  container->AddCheckableLabel(text, style, checked);
250  scroll_content()->AddChildView(container);
251  return container;
252}
253
254void AccessibilityDetailedView::OnViewClicked(views::View* sender) {
255  AccessibilityDelegate* delegate =
256      Shell::GetInstance()->accessibility_delegate();
257  if (sender == footer()->content()) {
258    TransitionToDefaultView();
259  } else if (sender == spoken_feedback_view_) {
260    Shell::GetInstance()->metrics()->RecordUserMetricsAction(
261        delegate->IsSpokenFeedbackEnabled() ?
262            ash::UMA_STATUS_AREA_DISABLE_SPOKEN_FEEDBACK :
263            ash::UMA_STATUS_AREA_ENABLE_SPOKEN_FEEDBACK);
264    delegate->ToggleSpokenFeedback(ash::A11Y_NOTIFICATION_NONE);
265  } else if (sender == high_contrast_view_) {
266    Shell::GetInstance()->metrics()->RecordUserMetricsAction(
267        delegate->IsHighContrastEnabled() ?
268            ash::UMA_STATUS_AREA_DISABLE_HIGH_CONTRAST :
269            ash::UMA_STATUS_AREA_ENABLE_HIGH_CONTRAST);
270    delegate->ToggleHighContrast();
271  } else if (sender == screen_magnifier_view_) {
272    Shell::GetInstance()->metrics()->RecordUserMetricsAction(
273        delegate->IsMagnifierEnabled() ?
274            ash::UMA_STATUS_AREA_DISABLE_MAGNIFIER :
275            ash::UMA_STATUS_AREA_ENABLE_MAGNIFIER);
276    delegate->SetMagnifierEnabled(!delegate->IsMagnifierEnabled());
277  } else if (large_cursor_view_ && sender == large_cursor_view_) {
278    Shell::GetInstance()->metrics()->RecordUserMetricsAction(
279        delegate->IsLargeCursorEnabled() ?
280            ash::UMA_STATUS_AREA_DISABLE_LARGE_CURSOR :
281            ash::UMA_STATUS_AREA_ENABLE_LARGE_CURSOR);
282    delegate->SetLargeCursorEnabled(!delegate->IsLargeCursorEnabled());
283  } else if (autoclick_view_ && sender == autoclick_view_) {
284    Shell::GetInstance()->metrics()->RecordUserMetricsAction(
285        delegate->IsAutoclickEnabled() ?
286            ash::UMA_STATUS_AREA_DISABLE_AUTO_CLICK :
287            ash::UMA_STATUS_AREA_ENABLE_AUTO_CLICK);
288    delegate->SetAutoclickEnabled(!delegate->IsAutoclickEnabled());
289  } else if (virtual_keyboard_view_ && sender == virtual_keyboard_view_) {
290    Shell::GetInstance()->metrics()->RecordUserMetricsAction(
291        delegate->IsVirtualKeyboardEnabled() ?
292            ash::UMA_STATUS_AREA_DISABLE_VIRTUAL_KEYBOARD :
293            ash::UMA_STATUS_AREA_ENABLE_VIRTUAL_KEYBOARD);
294    delegate->SetVirtualKeyboardEnabled(!delegate->IsVirtualKeyboardEnabled());
295  }
296}
297
298void AccessibilityDetailedView::ButtonPressed(views::Button* sender,
299                                              const ui::Event& event) {
300  SystemTrayDelegate* tray_delegate =
301      Shell::GetInstance()->system_tray_delegate();
302  if (sender == help_view_)
303    tray_delegate->ShowAccessibilityHelp();
304  else if (sender == settings_view_)
305    tray_delegate->ShowAccessibilitySettings();
306}
307
308}  // namespace tray
309
310////////////////////////////////////////////////////////////////////////////////
311// ash::internal::TrayAccessibility
312
313TrayAccessibility::TrayAccessibility(SystemTray* system_tray)
314    : TrayImageItem(system_tray, IDR_AURA_UBER_TRAY_ACCESSIBILITY),
315      default_(NULL),
316      detailed_popup_(NULL),
317      detailed_menu_(NULL),
318      request_popup_view_state_(A11Y_NONE),
319      tray_icon_visible_(false),
320      login_(GetCurrentLoginStatus()),
321      previous_accessibility_state_(GetAccessibilityState()),
322      show_a11y_menu_on_lock_screen_(true) {
323  DCHECK(Shell::GetInstance()->delegate());
324  DCHECK(system_tray);
325  Shell::GetInstance()->system_tray_notifier()->AddAccessibilityObserver(this);
326}
327
328TrayAccessibility::~TrayAccessibility() {
329  Shell::GetInstance()->system_tray_notifier()->
330      RemoveAccessibilityObserver(this);
331}
332
333void TrayAccessibility::SetTrayIconVisible(bool visible) {
334  if (tray_view())
335    tray_view()->SetVisible(visible);
336  tray_icon_visible_ = visible;
337}
338
339tray::AccessibilityDetailedView* TrayAccessibility::CreateDetailedMenu() {
340  return new tray::AccessibilityDetailedView(this, login_);
341}
342
343bool TrayAccessibility::GetInitialVisibility() {
344  // Shows accessibility icon if any accessibility feature is enabled.
345  // Otherwise, doen't show it.
346  return GetAccessibilityState() != A11Y_NONE;
347}
348
349views::View* TrayAccessibility::CreateDefaultView(user::LoginStatus status) {
350  CHECK(default_ == NULL);
351
352  // Shows accessibility menu if:
353  // - on login screen (not logged in);
354  // - "Enable accessibility menu" on chrome://settings is checked;
355  // - or any of accessibility features is enabled
356  // Otherwise, not shows it.
357  AccessibilityDelegate* delegate =
358      Shell::GetInstance()->accessibility_delegate();
359  if (login_ != user::LOGGED_IN_NONE &&
360      !delegate->ShouldShowAccessibilityMenu() &&
361      // On login screen, keeps the initial visibility of the menu.
362      (status != user::LOGGED_IN_LOCKED || !show_a11y_menu_on_lock_screen_))
363    return NULL;
364
365  CHECK(default_ == NULL);
366  default_ = new tray::DefaultAccessibilityView(this);
367
368  return default_;
369}
370
371views::View* TrayAccessibility::CreateDetailedView(user::LoginStatus status) {
372  CHECK(detailed_popup_ == NULL);
373  CHECK(detailed_menu_ == NULL);
374
375  if (request_popup_view_state_) {
376    detailed_popup_ =
377        new tray::AccessibilityPopupView(this, request_popup_view_state_);
378    request_popup_view_state_ = A11Y_NONE;
379    return detailed_popup_;
380  } else {
381    Shell::GetInstance()->metrics()->RecordUserMetricsAction(
382        ash::UMA_STATUS_AREA_DETAILED_ACCESSABILITY);
383    detailed_menu_ = CreateDetailedMenu();
384    return detailed_menu_;
385  }
386}
387
388void TrayAccessibility::DestroyDefaultView() {
389  default_ = NULL;
390}
391
392void TrayAccessibility::DestroyDetailedView() {
393  detailed_popup_ = NULL;
394  detailed_menu_ = NULL;
395}
396
397void TrayAccessibility::UpdateAfterLoginStatusChange(user::LoginStatus status) {
398  // Stores the a11y feature status on just entering the lock screen.
399  if (login_ != user::LOGGED_IN_LOCKED && status == user::LOGGED_IN_LOCKED)
400    show_a11y_menu_on_lock_screen_ = (GetAccessibilityState() != A11Y_NONE);
401
402  login_ = status;
403  SetTrayIconVisible(GetInitialVisibility());
404}
405
406void TrayAccessibility::OnAccessibilityModeChanged(
407    AccessibilityNotificationVisibility notify) {
408  SetTrayIconVisible(GetInitialVisibility());
409
410  uint32 accessibility_state = GetAccessibilityState();
411  // We'll get an extra notification if a braille display is connected when
412  // spoken feedback wasn't already enabled.  This is because the braille
413  // connection state is already updated when spoken feedback is enabled so
414  // that the notifications can be consolidated into one.  Therefore, we
415  // return early if there's no change in the state that we keep track of.
416  if (accessibility_state == previous_accessibility_state_)
417    return;
418  // Contains bits for spoken feedback and braille display connected currently
419  // being enabled.
420  uint32 being_enabled =
421      (accessibility_state & ~previous_accessibility_state_) &
422      (A11Y_SPOKEN_FEEDBACK | A11Y_BRAILLE_DISPLAY_CONNECTED);
423  if ((notify == ash::A11Y_NOTIFICATION_SHOW) && being_enabled != A11Y_NONE) {
424    // Shows popup if |notify| is true and the spoken feedback is being enabled.
425    request_popup_view_state_ = being_enabled;
426    PopupDetailedView(kTrayPopupAutoCloseDelayForTextInSeconds, false);
427  } else {
428    if (detailed_popup_)
429      detailed_popup_->GetWidget()->Close();
430    if (detailed_menu_)
431      detailed_menu_->GetWidget()->Close();
432  }
433
434  previous_accessibility_state_ = accessibility_state;
435}
436
437}  // namespace internal
438}  // namespace ash
439