[Mac][MC] Initial accessibility pass.

ui/message_center/cocoa/notification_controller.mm

 // Copyright (c) 2013 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.
 
 #import "ui/message_center/cocoa/notification_controller.h"
 
 #include "base/mac/foundation_util.h"
 #include "base/strings/string_util.h"
 #include "base/strings/sys_string_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "grit/ui_resources.h"
+#include "grit/ui_strings.h"
 #include "skia/ext/skia_utils_mac.h"
 #import "ui/base/cocoa/hover_image_button.h"
+#include "ui/base/l10n/l10n_util_mac.h"
 #include "ui/base/resource/resource_bundle.h"
 #include "ui/base/text/text_elider.h"
 #include "ui/message_center/message_center.h"
 #include "ui/message_center/message_center_style.h"
 #include "ui/message_center/notification.h"
 
 @interface MCNotificationButtonCell : NSButtonCell {
   BOOL hovered_;
 }
 @end
@@ skipping 58 matching lines @@
   // Else the cell won't be repainted on hover.
   [super mouseEntered:event];
 }
 
 - (void)mouseExited:(NSEvent*)event {
   hovered_ = NO;
   [super mouseExited:event];
 }
 @end
 
+////////////////////////////////////////////////////////////////////////////////
+
 @interface MCNotificationView : NSBox {
  @private
   MCNotificationController* controller_;
 }
 
 - (id)initWithController:(MCNotificationController*)controller
                    frame:(NSRect)frame;
 @end
 
 @implementation MCNotificationView
 - (id)initWithController:(MCNotificationController*)controller
                    frame:(NSRect)frame {
   if ((self = [super initWithFrame:frame]))
     controller_ = controller;
   return self;
 }
 
 - (void)mouseDown:(NSEvent*)event {
   if ([event type] != NSLeftMouseDown) {
     [super mouseDown:event];
     return;
   }
   [controller_ notificationClicked];
 }
+
+- (BOOL)accessibilityIsIgnored {
+  return NO;
+}
+
+- (NSArray*)accessibilityActionNames {
+  return @[ NSAccessibilityPressAction ];
+}
+
+- (void)accessibilityPerformAction:(NSString*)action {
+  if ([action isEqualToString:NSAccessibilityPressAction]) {
+    [controller_ notificationClicked];
+    return;
+  }
+  [super accessibilityPerformAction:action];
+}
 @end
 
+////////////////////////////////////////////////////////////////////////////////
+
+@interface AccessibilityIgnoredBox : NSBox
+@end
+
+@implementation AccessibilityIgnoredBox
+- (BOOL)accessibilityIsIgnored {
+  return YES;
+}
+@end

[Nico, 2013/06/20 21:03:23]

Huh, this looks like something that should already exist somewhere.

[Robert Sesek, 2013/06/22 01:56:00]

I couldn't find it. There's some other AccessibilityIgnoredX things in chrome/,
so I think we can centralize them, though.

+
+////////////////////////////////////////////////////////////////////////////////
+
 @interface MCNotificationController (Private)
 // Returns a string with item's title in title color and item's message in
 // message color.
 + (NSAttributedString*)
     attributedStringForItem:(const message_center::NotificationItem&)item
                        font:(NSFont*)font;
 
 // Configures a NSBox to be borderless, titleless, and otherwise appearance-
 // free.
 - (void)configureCustomBox:(NSBox*)box;
@@ skipping 20 matching lines @@
 - (NSRect)currentContentRect;
 
 // Returns the wrapped text that could fit within the given text field with not
 // more than the given number of lines. The Ellipsis could be added at the end
 // of the last line if it is too long.
 - (string16)wrapText:(const string16&)text
             forField:(NSTextField*)field
     maxNumberOfLines:(size_t)lines;
 @end
 
+////////////////////////////////////////////////////////////////////////////////
+
 @implementation MCNotificationController
 
 - (id)initWithNotification:(const message_center::Notification*)notification
     messageCenter:(message_center::MessageCenter*)messageCenter {
   if ((self = [super initWithNibName:nil bundle:nil])) {
     notification_ = notification;
     notificationID_ = notification_->id();
     messageCenter_ = messageCenter;
   }
   return self;
@@ skipping 77 matching lines @@
   // Create the list item views (up to a maximum).
   [listItemView_ removeFromSuperview];
   const std::vector<message_center::NotificationItem>& items =
       notification->items();
   NSRect listFrame = NSZeroRect;
   if (items.size() > 0) {
     listFrame = [self currentContentRect];
     listFrame.origin.y = 0;
     listFrame.size.height = 0;
     listItemView_.reset([[NSView alloc] initWithFrame:listFrame]);
+    [listItemView_ accessibilitySetOverrideValue:NSAccessibilityListRole

[dmazzoni, 2013/06/20 23:05:10]

This is a little confusing to me - is listItemView for a "list item", or is it
for a "list"?

I'd expect to see things with a role of NSAccessibilityListItemRole inside
something with a role of NSAccessibilityListRole.

I guess if it works with VoiceOver now, that's good. If it's working correctly,
then when you navigate to it you'd normally hear something like "list with 6
items".

[Robert Sesek, 2013/06/22 01:56:00]

listItemView is a container for list items.
That was my expectation, too, but there is no ListItemRole. I think it goes by
AXChildren.

+                                    forAttribute:NSAccessibilityRoleAttribute];
+    [listItemView_
+        accessibilitySetOverrideValue:NSAccessibilityContentListSubrole
+                         forAttribute:NSAccessibilitySubroleAttribute];
     CGFloat y = 0;
 
     NSFont* font = [NSFont systemFontOfSize:message_center::kMessageFontSize];
     CGFloat lineHeight = roundf(NSHeight([font boundingRectForFont]));
 
     const int kNumNotifications =
         std::min(items.size(), message_center::kNotificationMaximumItems);
     for (int i = kNumNotifications - 1; i >= 0; --i) {
       NSTextField* field = [self newLabelWithFrame:
           NSMakeRect(0, y, NSWidth(listFrame), lineHeight)];
@@ skipping 55 matching lines @@
     [button setTarget:self];
     [button setAction:@selector(buttonClicked:)];
     y += NSHeight(buttonFrame);
     frame.size.height += NSHeight(buttonFrame);
     [bottomView_ addSubview:button];
 
     NSRect separatorFrame = frame;
     separatorFrame.origin = NSMakePoint(0, y);
     separatorFrame.size.height = 1;
     scoped_nsobject<NSBox> separator(
-        [[NSBox alloc] initWithFrame:separatorFrame]);
+        [[AccessibilityIgnoredBox alloc] initWithFrame:separatorFrame]);
     [self configureCustomBox:separator];
     [separator setFillColor:gfx::SkColorToCalibratedNSColor(
         message_center::kButtonSeparatorColor)];
     y += NSHeight(separatorFrame);
     frame.size.height += NSHeight(separatorFrame);
     [bottomView_ addSubview:separator];
   }
 
   // Create the image view if appropriate.
   if (!notification->image().IsEmpty()) {
@@ skipping 93 matching lines @@
   [box setTitlePosition:NSNoTitle];
   [box setContentViewMargins:NSZeroSize];
 }
 
 - (NSView*)createImageView {
   // Create another box that shows a background color when the icon is not
   // big enough to fill the space.
   NSRect imageFrame = NSMakeRect(0, 0,
        message_center::kNotificationIconSize,
        message_center::kNotificationIconSize);
-  scoped_nsobject<NSBox> imageBox([[NSBox alloc] initWithFrame:imageFrame]);
+  scoped_nsobject<NSBox> imageBox(
+      [[AccessibilityIgnoredBox alloc] initWithFrame:imageFrame]);
   [self configureCustomBox:imageBox];
   [imageBox setFillColor:gfx::SkColorToCalibratedNSColor(
       message_center::kLegacyIconBackgroundColor)];
   [imageBox setAutoresizingMask:NSViewMinYMargin];
 
   // Inside the image box put the actual icon view.
   icon_.reset([[NSImageView alloc] initWithFrame:imageFrame]);
   [imageBox setContentView:icon_];
 
   return imageBox.autorelease();
@@ skipping 11 matching lines @@
   [closeButton_ setHoverImage:
       rb.GetNativeImageNamed(IDR_NOTIFICATION_CLOSE_HOVER).ToNSImage()];
   [closeButton_ setPressedImage:
       rb.GetNativeImageNamed(IDR_NOTIFICATION_CLOSE_PRESSED).ToNSImage()];
   [[closeButton_ cell] setHighlightsBy:NSOnState];
   [closeButton_ setTrackingEnabled:YES];
   [closeButton_ setBordered:NO];
   [closeButton_ setAutoresizingMask:NSViewMinYMargin];
   [closeButton_ setTarget:self];
   [closeButton_ setAction:@selector(close:)];
+  [[closeButton_ cell]
+      accessibilitySetOverrideValue:NSAccessibilityCloseButtonSubrole
+                       forAttribute:NSAccessibilitySubroleAttribute];
+  [[closeButton_ cell]
+      accessibilitySetOverrideValue:
+          l10n_util::GetNSString(IDS_APP_ACCNAME_CLOSE)
+                       forAttribute:NSAccessibilityTitleAttribute];
 }
 
 - (void)configureTitleInFrame:(NSRect)rootFrame {
   NSRect frame = [self currentContentRect];
   frame.size.height = 0;
   title_.reset([self newLabelWithFrame:frame]);
   [title_ setAutoresizingMask:NSViewMinYMargin];
   [title_ setTextColor:gfx::SkColorToCalibratedNSColor(
       message_center::kRegularTextColor)];
   [title_ setFont:[NSFont messageFontOfSize:message_center::kTitleFontSize]];
@@ skipping 49 matching lines @@
     if (font.GetStringWidth(last) > width)
       last = ui::ElideText(last, font, width, ui::ELIDE_AT_END);
     wrapped.resize(lines - 1);
     wrapped.push_back(last);
   }
 
   return JoinString(wrapped, '\n');
 }
 
 @end