[Mac] Add accessibility features to the new avatar menu

chrome/browser/ui/cocoa/profiles/profile_chooser_controller.mm

 // Copyright 2014 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 <Cocoa/Cocoa.h>
 
 #import "chrome/browser/ui/cocoa/profiles/profile_chooser_controller.h"
 
 #include "base/mac/bundle_locations.h"
 #include "base/prefs/pref_service.h"
@@ skipping 437 matching lines @@
      withController:(ProfileChooserController*)controller;
 
 // Called when the "Change" button is clicked.
 - (void)editPhoto:(id)sender;
 
 // When hovering over the profile photo, show the "Change" button.
 - (void)mouseEntered:(NSEvent*)event;
 
 // When hovering away from the profile photo, hide the "Change" button.
 - (void)mouseExited:(NSEvent*)event;
+
+- (BOOL)acceptsFirstResponder;
+- (BOOL)canBecomeKeyView;
+- (BOOL)accessibilityIsIgnored;
+- (NSArray*)accessibilityActionNames;
+- (void)accessibilityPerformAction:(NSString*)action;

[groby-ooo-7-16, 2014/08/15 00:38:35]

No need to declare any of them - they're all implemented by subclasses.

[noms (inactive), 2014/08/15 19:26:47]

Argh, sorry. I never know when to declare and when to not declare methods that
come from Cocoa. Is it "Cocoa.h declares everything so you never need to declare
anything in there?" :(

On 2014/08/15 00:38:35, groby wrote:

[groby-ooo-7-16, 2014/08/15 19:52:07]

This is one of the few places ObjC pretends to not be verbose. If a subclass
declared it, you're good to go. (Not that ObjC is fooling anybody there...)

 @end
 
 @interface EditableProfilePhoto (Private)
 // Create the "Change" avatar photo button.
 - (TransparentBackgroundButton*)changePhotoButtonWithRect:(NSRect)rect;
 @end
 
 @implementation EditableProfilePhoto
 - (id)initWithFrame:(NSRect)frameRect
          avatarMenu:(AvatarMenu*)avatarMenu
@@ skipping 15 matching lines @@
     [self addTrackingArea:trackingArea_.get()];
 
     NSRect bounds = NSMakeRect(0, 0, kLargeImageSide, kLargeImageSide);
     if (editingAllowed) {
       changePhotoButton_.reset([self changePhotoButtonWithRect:bounds]);
       [self addSubview:changePhotoButton_];
 
       // Hide the button until the image is hovered over.
       [changePhotoButton_ setHidden:YES];
     }
+
+    // Set the image cell's accessibility strings to be the same as the
+    // button's strings.
+    [[self cell] accessibilitySetOverrideValue:l10n_util::GetNSString(
+        editingAllowed ?
+        IDS_PROFILES_NEW_AVATAR_MENU_CHANGE_PHOTO_ACCESSIBLE_NAME :
+        IDS_PROFILES_NEW_AVATAR_MENU_PHOTO_ACCESSIBLE_NAME)
+                                  forAttribute:NSAccessibilityTitleAttribute];
+    [[self cell] accessibilitySetOverrideValue:
+        editingAllowed ? NSAccessibilityButtonRole : NSAccessibilityImageRole
+                                  forAttribute:NSAccessibilityRoleAttribute];
+    [[self cell] accessibilitySetOverrideValue:
+        NSAccessibilityRoleDescription(NSAccessibilityButtonRole, nil)
+            forAttribute:NSAccessibilityRoleDescriptionAttribute];
+
+    // The button and the cell should read the same thing.
+    [self accessibilitySetOverrideValue:l10n_util::GetNSString(
+        editingAllowed ?
+        IDS_PROFILES_NEW_AVATAR_MENU_CHANGE_PHOTO_ACCESSIBLE_NAME :
+        IDS_PROFILES_NEW_AVATAR_MENU_PHOTO_ACCESSIBLE_NAME)
+                                  forAttribute:NSAccessibilityTitleAttribute];
+    [self accessibilitySetOverrideValue:NSAccessibilityButtonRole
+                                  forAttribute:NSAccessibilityRoleAttribute];
+    [self accessibilitySetOverrideValue:
+        NSAccessibilityRoleDescription(NSAccessibilityButtonRole, nil)
+            forAttribute:NSAccessibilityRoleDescriptionAttribute];
   }
   return self;
 }
 
 - (void)drawRect:(NSRect)dirtyRect {
   NSRect bounds = [self bounds];
 
   // Display the profile picture as a circle.
   NSBezierPath* path = [NSBezierPath bezierPathWithOvalInRect:bounds];
   [path addClip];
@@ skipping 11 matching lines @@
 }
 
 - (void)mouseEntered:(NSEvent*)event {
   [changePhotoButton_ setHidden:NO];
 }
 
 - (void)mouseExited:(NSEvent*)event {
   [changePhotoButton_ setHidden:YES];
 }
 
+// Make sure the element is focusable for accessibility.
+- (BOOL)canBecomeKeyView {
+  return YES;
+}
+
+- (BOOL)acceptsFirstResponder {
+  return YES;
+}
+
+- (BOOL)accessibilityIsIgnored {
+  return NO;
+}
+
+- (NSArray*)accessibilityActionNames {
+  NSArray* parentActions = [super accessibilityActionNames];
+  return [parentActions arrayByAddingObject:NSAccessibilityPressAction];
+}
+
+- (void)accessibilityPerformAction:(NSString*)action {
+  if ([action isEqualToString:NSAccessibilityPressAction]) {
+    avatarMenu_->EditProfile(avatarMenu_->GetActiveProfileIndex());
+  }
+
+  [super accessibilityPerformAction:action];
+}
+
 - (TransparentBackgroundButton*)changePhotoButtonWithRect:(NSRect)rect {
   TransparentBackgroundButton* button =
       [[TransparentBackgroundButton alloc] initWithFrame:rect];
   [button setImage:ui::ResourceBundle::GetSharedInstance().GetNativeImageNamed(
       IDR_ICON_PROFILES_EDIT_CAMERA).AsNSImage()];
   [button setImagePosition:NSImageOnly];
   [button setTarget:self];
   [button setAction:@selector(editPhoto:)];
   return button;
 }
@@ skipping 12 matching lines @@
         profileName:(NSString*)profileName
      editingAllowed:(BOOL)editingAllowed
      withController:(ProfileChooserController*)controller;
 
 // Called when the button is clicked.
 - (void)showEditableView:(id)sender;
 
 // Called when enter is pressed in the text field.
 - (void)saveProfileName:(id)sender;
 
+- (BOOL)acceptsFirstResponder;
+
 @end
 
 @implementation EditableProfileNameButton
 - (id)initWithFrame:(NSRect)frameRect
             profile:(Profile*)profile
         profileName:(NSString*)profileName
      editingAllowed:(BOOL)editingAllowed
      withController:(ProfileChooserController*)controller {
   if ((self = [super initWithFrame:frameRect])) {
     profile_ = profile;
@@ skipping 40 matching lines @@
       [[profileNameTextField_ cell] setLineBreakMode:
           NSLineBreakByTruncatingTail];
       [self addSubview:profileNameTextField_];
       [profileNameTextField_ setTarget:self];
       [profileNameTextField_ setAction:@selector(saveProfileName:)];
 
       // Hide the textfield until the user clicks on the button.
       [profileNameTextField_ setHidden:YES];
     }
 
+    [[self cell] accessibilitySetOverrideValue:NSAccessibilityButtonRole
+                           forAttribute:NSAccessibilityRoleAttribute];
+    [[self cell] accessibilitySetOverrideValue:
+        NSAccessibilityRoleDescription(NSAccessibilityButtonRole, nil)
+          forAttribute:NSAccessibilityRoleDescriptionAttribute];
+
     [self setBordered:NO];
     [self setFont:[NSFont labelFontOfSize:kTitleFontSize]];
     [self setAlignment:NSCenterTextAlignment];
     [[self cell] setLineBreakMode:NSLineBreakByTruncatingTail];
     [self setTitle:profileName];
   }
   return self;
 }
 
 - (void)saveProfileName:(id)sender {
   NSString* text = [profileNameTextField_ stringValue];
   // Empty profile names are not allowed, and are treated as a cancel.
   if ([text length] > 0) {
     profiles::UpdateProfileName(profile_, base::SysNSStringToUTF16(text));
     [controller_
         postActionPerformed:ProfileMetrics::PROFILE_DESKTOP_MENU_EDIT_NAME];
     [self setTitle:text];
   }
   [profileNameTextField_ setHidden:YES];
 }
 
 - (void)showEditableView:(id)sender {
   [profileNameTextField_ setHidden:NO];
   [[self window] makeFirstResponder:profileNameTextField_];
 }
 
+- (BOOL)acceptsFirstResponder {

[groby-ooo-7-16, 2014/08/15 00:38:35]

Technically, a control's -acceptsFirstResponder is driven by the cell's
-refusesFirstResponder. (And that usually results in YES).

Are you sure you need these?

[noms (inactive), 2014/08/15 19:26:47]

No. I think I just hoped these would make regular tabbing work. They don't.

On 2014/08/15 00:38:35, groby wrote:

+  return YES;
+}
+
 @end
 
 // A custom button that allows for setting a background color when hovered over.
 @interface BackgroundColorHoverButton : HoverImageButton {
  @private
   base::scoped_nsobject<NSColor> backgroundColor_;
   base::scoped_nsobject<NSColor> hoverColor_;
 }
 @end
 
@@ skipping 27 matching lines @@
 }
 
 - (void)setHoverState:(HoverState)state {
   [super setHoverState:state];
   bool isHighlighted = ([self hoverState] != kHoverStateNone);
 
   NSColor* backgroundColor = isHighlighted ? hoverColor_ : backgroundColor_;
   [[self cell] setBackgroundColor:backgroundColor];
 }
 
+- (BOOL)acceptsFirstResponder {
+  return YES;
+}
+
 @end
 
 // A custom view with the given background color.
 @interface BackgroundColorView : NSView {
  @private
   base::scoped_nsobject<NSColor> backgroundColor_;
 }
 @end
 
 @implementation BackgroundColorView
@@ skipping 276 matching lines @@
     // If view mode is PROFILE_CHOOSER but there is an auth error, force
     // ACCOUNT_MANAGEMENT mode.
     if (viewMode_ == profiles::BUBBLE_VIEW_MODE_PROFILE_CHOOSER &&
         HasAuthError(browser_->profile()) &&
         switches::IsEnableAccountConsistency() &&
         avatarMenu_->GetItemAt(avatarMenu_->GetActiveProfileIndex()).
             signed_in) {
       viewMode_ = profiles::BUBBLE_VIEW_MODE_ACCOUNT_MANAGEMENT;
     }
 
+    [window accessibilitySetOverrideValue:
+        l10n_util::GetNSString(IDS_PROFILES_NEW_AVATAR_MENU_ACCESSIBLE_NAME)
+                             forAttribute:NSAccessibilityTitleAttribute];
+    [window accessibilitySetOverrideValue:
+        l10n_util::GetNSString(IDS_PROFILES_NEW_AVATAR_MENU_ACCESSIBLE_NAME)
+                             forAttribute:NSAccessibilityHelpAttribute];
+
     [[self bubble] setAlignment:info_bubble::kAlignRightEdgeToAnchorEdge];
     [[self bubble] setArrowLocation:info_bubble::kNoArrow];
     [[self bubble] setBackgroundColor:GetDialogBackgroundColor()];
     [self initMenuContentsWithView:viewMode_];
   }
 
   return self;
 }
 
 - (void)initMenuContentsWithView:(profiles::BubbleViewMode)viewToDisplay {
@@ skipping 392 matching lines @@
         link = [self linkButtonWithTitle:email
                              frameOrigin:rect.origin
                                   action:nil];
         [link setImage:ui::ResourceBundle::GetSharedInstance().
             GetNativeImageNamed(IDR_ICON_PROFILES_ACCOUNT_BUTTON_ERROR).
             ToNSImage()];
         [link setImagePosition:NSImageRight];
         [link setTarget:self];
         [link setAction:@selector(showAccountReauthenticationView:)];
         [link setTag:kPrimaryProfileTag];
+        [[link cell]
+            accessibilitySetOverrideValue:l10n_util::GetNSStringF(
+            IDS_PROFILES_ACCOUNT_BUTTON_AUTH_ERROR_ACCESSIBLE_NAME,
+            item.sync_state)
+                             forAttribute:NSAccessibilityTitleAttribute];
       } else {
         NSTextField* label = BuildLabel(email, rect.origin, nil);
         [label setAlignment:NSCenterTextAlignment];
         [label setFrame:rect];
         [container addSubview:label];
       }
     }
     // -linkButtonWithTitle sizeToFit's the link, so re-stretch it so that it
     // can be centered correctly in the view.
     if (link) {
@@ skipping 554 matching lines @@
 }
 
 - (bool)shouldShowGoIncognito {
   bool incognitoAvailable =
       IncognitoModePrefs::GetAvailability(browser_->profile()->GetPrefs()) !=
           IncognitoModePrefs::DISABLED;
   return incognitoAvailable && !browser_->profile()->IsGuestSession();
 }
 
 @end