#include <ax_platform_node_mac.h>

Inheritance diagram for AXPlatformNodeCocoa:

Instance Methods
(instancetype)	- initWithNode:

(void)	- detach

(NSString *)	- getStringAttribute: `[implementation]`

(NSString *)	- getAXValueAsString `[implementation]`

(NSString *)	- getName `[implementation]`

(std::unique_ptr< AnnouncementSpec >)	- announcementForEvent: `[implementation]`

(void)	- scheduleLiveRegionAnnouncement: `[implementation]`

(BOOL)	- accessibilityIsIgnored `[implementation]`

(id)	- accessibilityHitTest: `[implementation]`

(BOOL)	- accessibilityNotifiesWhenDestroyed `[implementation]`

(id)	- accessibilityFocusedUIElement `[implementation]`

(NSArray *)	- accessibilityActionNames `[implementation]`

(void)	- accessibilityPerformAction: `[implementation]`

(NSString *)	- AXRoleInternal `[implementation]`

(NSString *)	- AXRoleDescriptionInternal `[implementation]`

(NSString *)	- AXSubroleInternal `[implementation]`

(NSString *)	- AXHelpInternal `[implementation]`

(id)	- AXValueInternal `[implementation]`

(NSNumber *)	- AXEnabledInternal `[implementation]`

(NSNumber *)	- AXFocusedInternal `[implementation]`

(id)	- AXParentInternal `[implementation]`

(NSArray *)	- AXChildrenInternal `[implementation]`

(id)	- AXWindowInternal `[implementation]`

(id)	- AXTopLevelUIElementInternal `[implementation]`

(NSValue *)	- AXPositionInternal `[implementation]`

(NSValue *)	- AXSizeInternal `[implementation]`

(NSString *)	- AXTitleInternal `[implementation]`

(NSNumber *)	- AXSelectedInternal `[implementation]`

(NSString *)	- AXPlaceholderValueInternal `[implementation]`

(NSString *)	- AXMenuItemMarkChar `[implementation]`

(NSString *)	- AXSelectedTextInternal `[implementation]`

(NSValue *)	- AXSelectedTextRangeInternal `[implementation]`

(NSNumber *)	- AXNumberOfCharactersInternal `[implementation]`

(NSValue *)	- AXVisibleCharacterRangeInternal `[implementation]`

(NSNumber *)	- AXInsertionPointLineNumberInternal `[implementation]`

(NSString *)	- description `[implementation]`

(NSArray *)	- accessibilityChildren `[implementation]`

(BOOL)	- isAccessibilityElement `[implementation]`

(BOOL)	- isAccessibilityEnabled `[implementation]`

(NSRect)	- accessibilityFrame `[implementation]`

(NSString *)	- accessibilityLabel `[implementation]`

(NSString *)	- accessibilityTitle `[implementation]`

(id)	- accessibilityValue `[implementation]`

(NSAccessibilityRole)	- accessibilityRole `[implementation]`

(NSString *)	- accessibilityRoleDescription `[implementation]`

(NSAccessibilitySubrole)	- accessibilitySubrole `[implementation]`

(NSString *)	- accessibilityHelp `[implementation]`

(id)	- accessibilityParent `[implementation]`

(id)	- accessibilityWindow `[implementation]`

(id)	- accessibilityTopLevelUIElement `[implementation]`

(BOOL)	- accessibilitySelected `[implementation]`

(BOOL)	- isAccessibilitySelectorAllowed: `[implementation]`

(void)	- setAccessibilityValue: `[implementation]`

(void)	- setAccessibilityFocused: `[implementation]`

(void)	- setAccessibilitySelectedText: `[implementation]`

(void)	- setAccessibilitySelectedTextRange: `[implementation]`

(NSInteger)	- accessibilityInsertionPointLineNumber `[implementation]`

(NSInteger)	- accessibilityNumberOfCharacters `[implementation]`

(NSString *)	- accessibilityPlaceholderValue `[implementation]`

(NSString *)	- accessibilitySelectedText `[implementation]`

(NSRange)	- accessibilitySelectedTextRange `[implementation]`

(NSArray *)	- accessibilitySelectedTextRanges `[implementation]`

(NSRange)	- accessibilitySharedCharacterRange `[implementation]`

(NSArray *)	- accessibilitySharedTextUIElements `[implementation]`

(NSRange)	- accessibilityVisibleCharacterRange `[implementation]`

(NSString *)	- accessibilityStringForRange: `[implementation]`

(NSAttributedString *)	- accessibilityAttributedStringForRange: `[implementation]`

(NSData *)	- accessibilityRTFForRange: `[implementation]`

(NSRect)	- accessibilityFrameForRange: `[implementation]`

(NSInteger)	- accessibilityLineForIndex: `[implementation]`

(NSRange)	- accessibilityRangeForIndex: `[implementation]`

(NSRange)	- accessibilityStyleRangeForIndex: `[implementation]`

(NSRange)	- accessibilityRangeForLine: `[implementation]`

(NSRange)	- accessibilityRangeForPosition: `[implementation]`

(NSArray *)	- accessibilitySharedFocusElements `[implementation]`

(id)	- accessibilityFocusedWindow `[implementation]`

(id)	- accessibilityApplicationFocusedUIElement `[implementation]`

(BOOL)	- isAccessibilityFocused `[implementation]`

Class Methods
(NSString *)	+ nativeRoleFromAXRole:

(NSString *)	+ nativeSubroleFromAXRole:

(NSString *)	+ nativeNotificationFromAXEvent:

Properties
NSRect	boundsInScreen

ui::AXPlatformNodeBase *	node

Detailed Description

Definition at line 54 of file ax_platform_node_mac.h.

Method Documentation

◆ accessibilityActionNames

- (NSArray *) accessibilityActionNames

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                     {
  if (!_node)
    return @[];
 
  base::scoped_nsobject<NSMutableArray> axActions([[NSMutableArray alloc] init]);
 
  const ui::AXNodeData& data = _node->GetData();
  const ActionList& action_list = GetActionList();
 
  // VoiceOver expects the "press" action to be first. Note that some roles
  // should be given a press action implicitly.
  BASE_DCHECK([action_list[0].second isEqualToString:NSAccessibilityPressAction]);
  for (const auto& item : action_list) {
    if (data.HasAction(item.first) || HasImplicitAction(data, item.first))
      [axActions addObject:item.second];
  }
 
  if (AlsoUseShowMenuActionForDefaultAction(data))
    [axActions addObject:NSAccessibilityShowMenuAction];
 
  return axActions.autorelease();
}

◆ accessibilityApplicationFocusedUIElement

- (id) accessibilityApplicationFocusedUIElement

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                               {
  if (![[self AXFocusedInternal] boolValue])
    return nil;
  return self;
}

◆ accessibilityAttributedStringForRange:

- (NSAttributedString *) accessibilityAttributedStringForRange: (NSRange) range

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                                            :(NSRange)range {
  if (!_node)
    return nil;
  // TODO(https://crbug.com/958811): Implement this for real.
  base::scoped_nsobject<NSAttributedString> attributedString(
      [[NSAttributedString alloc] initWithString:[self accessibilityStringForRange:range]]);
  return attributedString.autorelease();
}

◆ accessibilityChildren

- (NSArray *) accessibilityChildren

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                  {
  return [self AXChildrenInternal];
}

◆ accessibilityFocusedUIElement

- (id) accessibilityFocusedUIElement

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                    {
  return _node ? _node->GetDelegate()->GetFocus() : nil;
}

◆ accessibilityFocusedWindow

- (id) accessibilityFocusedWindow

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                 {
  if (![[self AXFocusedInternal] boolValue])
    return nil;
  return self;
}

◆ accessibilityFrame

- (NSRect) accessibilityFrame

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                             {
  return [self boundsInScreen];
}

◆ accessibilityFrameForRange:

- (NSRect) accessibilityFrameForRange: (NSRange) range

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                    :(NSRange)range {
  return NSZeroRect;
}

◆ accessibilityHelp

- (NSString *) accessibilityHelp

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                               {
  return [self AXHelpInternal];
}

◆ accessibilityHitTest:

- (id) accessibilityHitTest: (NSPoint) point

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                          :(NSPoint)point {
  if (!NSPointInRect(point, [self boundsInScreen]))
    return nil;
 
  for (id child in [[self AXChildrenInternal] reverseObjectEnumerator]) {
    if (!NSPointInRect(point, [child accessibilityFrame]))
      continue;
    if (id foundChild = [child accessibilityHitTest:point])
      return foundChild;
  }
 
  // Hit self, but not any child.
  return NSAccessibilityUnignoredAncestor(self);
}

◆ accessibilityInsertionPointLineNumber

- (NSInteger) accessibilityInsertionPointLineNumber

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                                   {
  return [[self AXInsertionPointLineNumberInternal] integerValue];
}

◆ accessibilityIsIgnored

- (BOOL) accessibilityIsIgnored

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                               {
  if (!_node)
    return YES;
 
  return [[self AXRoleInternal] isEqualToString:NSAccessibilityUnknownRole] ||
         _node->GetData().HasState(ax::mojom::State::kInvisible);
}

◆ accessibilityLabel

- (NSString *) accessibilityLabel

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                {
  // accessibilityLabel is "a short description of the accessibility element",
  // and accessibilityTitle is "the title of the accessibility element"; at
  // least in Chromium, the title usually is a short description of the element,
  // so it also functions as a label.
  return [self AXTitleInternal];
}

◆ accessibilityLineForIndex:

- (NSInteger) accessibilityLineForIndex: (NSInteger) index

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                      :(NSInteger)index {
  // Views textfields are single-line.
  return 0;
}

◆ accessibilityNotifiesWhenDestroyed

- (BOOL) accessibilityNotifiesWhenDestroyed

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                           {
  return YES;
}

◆ accessibilityNumberOfCharacters

- (NSInteger) accessibilityNumberOfCharacters

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                             {
  if (!_node)
    return 0;
  return [[self AXNumberOfCharactersInternal] integerValue];
}

◆ accessibilityParent

- (id) accessibilityParent

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                          {
  return [self AXParentInternal];
}

◆ accessibilityPerformAction:

- (void) accessibilityPerformAction: (NSString*) action

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                  :(NSString*)action {
  // Actions are performed asynchronously, so it's always possible for an object
  // to change its mind after previously reporting an action as available.
  if (![[self accessibilityActionNames] containsObject:action])
    return;
 
  ui::AXActionData data;
  if ([action isEqualToString:NSAccessibilityShowMenuAction] &&
      AlsoUseShowMenuActionForDefaultAction(_node->GetData())) {
    data.action = ax::mojom::Action::kDoDefault;
  } else {
    for (const ActionList::value_type& entry : GetActionList()) {
      if ([action isEqualToString:entry.second]) {
        data.action = entry.first;
        break;
      }
    }
  }
 
  // Note ui::AX_ACTIONs which are just overwriting an accessibility attribute
  // are already implemented in -accessibilitySetValue:forAttribute:, so ignore
  // those here.
 
  if (data.action != ax::mojom::Action::kNone)
    _node->GetDelegate()->AccessibilityPerformAction(data);
}

◆ accessibilityPlaceholderValue

- (NSString *) accessibilityPlaceholderValue

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                           {
  if (!_node)
    return nil;
 
  return [self AXPlaceholderValueInternal];
}

◆ accessibilityRangeForIndex:

- (NSRange) accessibilityRangeForIndex: (NSInteger) index

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                     :(NSInteger)index {
  BASE_UNREACHABLE();
  return NSMakeRange(0, 0);
}

◆ accessibilityRangeForLine:

- (NSRange) accessibilityRangeForLine: (NSInteger) line

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                    :(NSInteger)line {
  if (!_node)
    return NSMakeRange(0, 0);
 
  if (line != 0) {
    BASE_LOG() << "Views textfields are single-line.";
    BASE_UNREACHABLE();
  }
  return NSMakeRange(0, [self accessibilityNumberOfCharacters]);
}

◆ accessibilityRangeForPosition:

- (NSRange) accessibilityRangeForPosition: (NSPoint) point

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                        :(NSPoint)point {
  // TODO(a-wallen): Framework needs to send Text Metrics
  // to the AXTree in order for a NSPoint (x, y) to be
  // translated to the appropriate range of UTF-16 chars.
  return NSMakeRange(0, 0);
}

◆ accessibilityRole

- (NSAccessibilityRole) accessibilityRole

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                         {
  return [self AXRoleInternal];
}

◆ accessibilityRoleDescription

- (NSString *) accessibilityRoleDescription

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                          {
  return [self AXRoleDescriptionInternal];
}

◆ accessibilityRTFForRange:

- (NSData *) accessibilityRTFForRange: (NSRange) range

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                   :(NSRange)range {
  return nil;
}

◆ accessibilitySelected

- (BOOL) accessibilitySelected

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                              {
  return [[self AXSelectedInternal] boolValue];
}

◆ accessibilitySelectedText

- (NSString *) accessibilitySelectedText

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                       {
  if (!_node)
    return nil;
 
  return [self AXSelectedTextInternal];
}

◆ accessibilitySelectedTextRange

- (NSRange) accessibilitySelectedTextRange

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                          {
  if (!_node)
    return NSMakeRange(0, 0);
 
  NSRange r;
  [[self AXSelectedTextRangeInternal] getValue:&r];
  return r;
}

◆ accessibilitySelectedTextRanges

- (NSArray *) accessibilitySelectedTextRanges

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                            {
  if (!_node)
    return nil;
 
  return @[ [self AXSelectedTextRangeInternal] ];
}

◆ accessibilitySharedCharacterRange

- (NSRange) accessibilitySharedCharacterRange

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                             {
  if (!_node)
    return NSMakeRange(0, 0);
 
  NSRange r;
  [[self AXSelectedTextRangeInternal] getValue:&r];
  return r;
}

◆ accessibilitySharedFocusElements

- (NSArray *) accessibilitySharedFocusElements

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                             {
  if (![[self AXFocusedInternal] boolValue])
    return nil;
  return @[ self ];
}

◆ accessibilitySharedTextUIElements

- (NSArray *) accessibilitySharedTextUIElements

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                              {
  if (!_node)
    return nil;
 
  return @[ self ];
}

◆ accessibilityStringForRange:

- (NSString *) accessibilityStringForRange: (NSRange) range

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                        :(NSRange)range {
  if (!_node)
    return nil;
 
  return [[self getAXValueAsString] substringWithRange:range];
}

◆ accessibilityStyleRangeForIndex:

- (NSRange) accessibilityStyleRangeForIndex: (NSInteger) index

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                          :(NSInteger)index {
  if (!_node)
    return NSMakeRange(0, 0);
 
  // TODO(https://crbug.com/958811): Implement this for real.
  return NSMakeRange(0, [self accessibilityNumberOfCharacters]);
}

◆ accessibilitySubrole

- (NSAccessibilitySubrole) accessibilitySubrole

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                               {
  return [self AXSubroleInternal];
}

◆ accessibilityTitle

- (NSString *) accessibilityTitle

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                {
  return [self AXTitleInternal];
}

◆ accessibilityTopLevelUIElement

- (id) accessibilityTopLevelUIElement

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                     {
  return [self AXTopLevelUIElementInternal];
}

◆ accessibilityValue

- (id) accessibilityValue

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                         {
  return [self AXValueInternal];
}

◆ accessibilityVisibleCharacterRange

- (NSRange) accessibilityVisibleCharacterRange

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                              {
  if (!_node)
    return NSMakeRange(0, 0);
 
  return [[self AXVisibleCharacterRangeInternal] rangeValue];
}

◆ accessibilityWindow

- (id) accessibilityWindow

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                          {
  return [self AXWindowInternal];
}

◆ announcementForEvent:

- (unique_ptr< AnnouncementSpec >) AXPlatformNodeCocoa: (ax::mojom::Event) eventType

implementation

Provided by category AXPlatformNodeCocoa(Private).

Definition at line 359 of file ax_platform_node_mac.mm.

                                                       :(ax::mojom::Event)eventType {
  // Only alerts and live region changes should be announced.
  BASE_DCHECK(eventType == ax::mojom::Event::kAlert ||
              eventType == ax::mojom::Event::kLiveRegionChanged);
  std::string liveStatus = _node->GetStringAttribute(ax::mojom::StringAttribute::kLiveStatus);
  // If live status is explicitly set to off, don't announce.
  if (liveStatus == "off")
    return nullptr;
 
  NSString* name = [self getName];
  NSString* announcementText = name;
  if ([announcementText length] <= 0) {
    announcementText = @(base::UTF16ToUTF8(_node->GetInnerText()).data());
  }
  if ([announcementText length] == 0)
    return nullptr;
 
  auto announcement = std::make_unique<AnnouncementSpec>();
  announcement->announcement = base::scoped_nsobject<NSString>([announcementText retain]);
  announcement->window = base::scoped_nsobject<NSWindow>([[self AXWindowInternal] retain]);
  announcement->is_polite = liveStatus != "assertive";
  return announcement;
}

◆ AXChildrenInternal

- (NSArray *) AXChildrenInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                               {
  if (!_node)
    return @[];
 
  int count = _node->GetChildCount();
  NSMutableArray* children = [NSMutableArray arrayWithCapacity:count];
  for (auto child_iterator_ptr = _node->GetDelegate()->ChildrenBegin();
       *child_iterator_ptr != *_node->GetDelegate()->ChildrenEnd(); ++(*child_iterator_ptr)) {
    [children addObject:child_iterator_ptr->GetNativeViewAccessible()];
  }
  return NSAccessibilityUnignoredChildren(children);
}

◆ AXEnabledInternal

- (NSNumber *) AXEnabledInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                               {
  return @(_node->GetData().GetRestriction() != ax::mojom::Restriction::kDisabled);
}

◆ AXFocusedInternal

- (NSNumber *) AXFocusedInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                               {
  if (_node->GetData().HasState(ax::mojom::State::kFocusable))
    return @(_node->GetDelegate()->GetFocus() == _node->GetNativeViewAccessible());
  return @NO;
}

◆ AXHelpInternal

- (NSString *) AXHelpInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                            {
  // TODO(aleventhal) Key shortcuts attribute should eventually get
  // its own field. Follow what WebKit does for aria-keyshortcuts, see
  // https://bugs.webkit.org/show_bug.cgi?id=159215 (WebKit bug).
  NSString* desc = [self getStringAttribute:ax::mojom::StringAttribute::kDescription];
  NSString* key = [self getStringAttribute:ax::mojom::StringAttribute::kKeyShortcuts];
  if (!desc.length)
    return key.length ? key : @"";
  if (!key.length)
    return desc;
  return [NSString stringWithFormat:@"%@ %@", desc, key];
}

◆ AXInsertionPointLineNumberInternal

- (NSNumber *) AXInsertionPointLineNumberInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                                {
  // Multiline is not supported on views.
  return @0;
}

◆ AXMenuItemMarkChar

- (NSString *) AXMenuItemMarkChar

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                {
  if (!ui::IsMenuItem(_node->GetData().role))
    return nil;
 
  const auto checkedState = static_cast<ax::mojom::CheckedState>(
      _node->GetIntAttribute(ax::mojom::IntAttribute::kCheckedState));
  if (checkedState == ax::mojom::CheckedState::kTrue) {
    return @"\xE2\x9C\x93";  // UTF-8 for unicode 0x2713, "check mark"
  }
 
  return @"";
}

◆ AXNumberOfCharactersInternal

- (NSNumber *) AXNumberOfCharactersInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                          {
  return @([[self getAXValueAsString] length]);
}

◆ AXParentInternal

- (id) AXParentInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                       {
  if (!_node)
    return nil;
  return NSAccessibilityUnignoredAncestor(_node->GetParent());
}

◆ AXPlaceholderValueInternal

- (NSString *) AXPlaceholderValueInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                        {
  return [self getStringAttribute:ax::mojom::StringAttribute::kPlaceholder];
}

◆ AXPositionInternal

- (NSValue *) AXPositionInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                               {
  return [NSValue valueWithPoint:self.boundsInScreen.origin];
}

◆ AXRoleDescriptionInternal

- (NSString *) AXRoleDescriptionInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                       {
  switch (_node->GetData().role) {
    case ax::mojom::Role::kTab:
      // There is no NSAccessibilityTabRole or similar (AXRadioButton is used
      // instead). Do the same as NSTabView and put "tab" in the description.
      // return [l10n_util::GetNSStringWithFixup(IDS_ACCNAME_TAB_ROLE_DESCRIPTION)
      //     lowercaseString];
      return nil;
    case ax::mojom::Role::kDisclosureTriangle:
      // return [l10n_util::GetNSStringWithFixup(
      //     IDS_ACCNAME_DISCLOSURE_TRIANGLE_ROLE_DESCRIPTION) lowercaseString];
      return nil;
    default:
      break;
  }
  return NSAccessibilityRoleDescription([self AXRoleInternal], [self AXSubroleInternal]);
}

◆ AXRoleInternal

- (NSString *) AXRoleInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                            {
  if (!_node)
    return nil;
 
  return [[self class] nativeRoleFromAXRole:_node->GetData().role];
}

◆ AXSelectedInternal

- (NSNumber *) AXSelectedInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                {
  return @(_node->GetData().GetBoolAttribute(ax::mojom::BoolAttribute::kSelected));
}

◆ AXSelectedTextInternal

- (NSString *) AXSelectedTextInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                    {
  NSRange selectedTextRange;
  [[self AXSelectedTextRangeInternal] getValue:&selectedTextRange];
  return [[self getAXValueAsString] substringWithRange:selectedTextRange];
}

◆ AXSelectedTextRangeInternal

- (NSValue *) AXSelectedTextRangeInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                        {
  int start = _node->GetIntAttribute(ax::mojom::IntAttribute::kTextSelStart);
  int end = _node->GetIntAttribute(ax::mojom::IntAttribute::kTextSelEnd);
  NSAssert((start >= 0 && end >= 0) || (start == -1 && end == -1), @"selection is invalid");
 
  if (start == -1 && end == -1) {
    return [NSValue valueWithRange:{NSNotFound, 0}];
  }
  // NSRange cannot represent the direction the text was selected in.
  return [NSValue valueWithRange:{static_cast<NSUInteger>(std::min(start, end)),
                                  static_cast<NSUInteger>(abs(end - start))}];
}

◆ AXSizeInternal

- (NSValue *) AXSizeInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                           {
  return [NSValue valueWithSize:self.boundsInScreen.size];
}

◆ AXSubroleInternal

- (NSString *) AXSubroleInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                               {
  ax::mojom::Role role = _node->GetData().role;
  switch (role) {
    case ax::mojom::Role::kTextField:
      if (_node->GetData().HasState(ax::mojom::State::kProtected))
        return NSAccessibilitySecureTextFieldSubrole;
      break;
    default:
      break;
  }
  return [AXPlatformNodeCocoa nativeSubroleFromAXRole:role];
}

◆ AXTitleInternal

- (NSString *) AXTitleInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                             {
  if (ui::IsNameExposedInAXValueForRole(_node->GetData().role))
    return @"";
 
  return [self getName];
}

◆ AXTopLevelUIElementInternal

- (id) AXTopLevelUIElementInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                  {
  return [self AXWindowInternal];
}

◆ AXValueInternal

- (id) AXValueInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                      {
  ax::mojom::Role role = _node->GetData().role;
  if (role == ax::mojom::Role::kTab)
    return [self AXSelectedInternal];
 
  if (ui::IsNameExposedInAXValueForRole(role)) {
    if (role == ax::mojom::Role::kStaticText) {
      // Static texts may store their texts in the value attributes. For
      // example, the selectable text stores its text in value instead of
      // name.
      NSString* value = [self getName];
      if (value.length == 0) {
        value = [self getStringAttribute:ax::mojom::StringAttribute::kValue];
      }
      return value;
    }
    return [self getName];
  }
 
  if (_node->IsPlatformCheckable()) {
    // Mixed checkbox state not currently supported in views, but could be.
    // See browser_accessibility_cocoa.mm for details.
    const auto checkedState = static_cast<ax::mojom::CheckedState>(
        _node->GetIntAttribute(ax::mojom::IntAttribute::kCheckedState));
    return checkedState == ax::mojom::CheckedState::kTrue ? @1 : @0;
  }
  return [self getStringAttribute:ax::mojom::StringAttribute::kValue];
}

◆ AXVisibleCharacterRangeInternal

- (NSValue *) AXVisibleCharacterRangeInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                            {
  return [NSValue valueWithRange:{0, [[self getAXValueAsString] length]}];
}

◆ AXWindowInternal

- (id) AXWindowInternal

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                       {
  return _node->GetDelegate()->GetNSWindow();
}

◆ description

- (NSString *) description

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                         {
  return [NSString stringWithFormat:@"%@ - %@ (%@)", [super description], [self AXTitleInternal],
                                    [self AXRoleInternal]];
}

◆ detach

- (void) detach

Definition at line 359 of file ax_platform_node_mac.mm.

               {
  if (!_node)
    return;
  _node = nil;
  NSAccessibilityPostNotification(self, NSAccessibilityUIElementDestroyedNotification);
}

◆ getAXValueAsString

- (NSString *) getAXValueAsString

implementation

Provided by category AXPlatformNodeCocoa(Private).

Definition at line 359 of file ax_platform_node_mac.mm.

                                {
  id value = [self AXValueInternal];
  return [value isKindOfClass:[NSString class]] ? value : nil;
}

◆ getName

- (NSString *) getName

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                     {
  return @(_node->GetName().data());
}

◆ getStringAttribute:

- (NSString *) getStringAttribute: (ax::mojom::StringAttribute) attribute

implementation

Provided by category AXPlatformNodeCocoa(Private).

Definition at line 359 of file ax_platform_node_mac.mm.

                               :(ax::mojom::StringAttribute)attribute {
  std::string attributeValue;
  if (_node->GetStringAttribute(attribute, &attributeValue))
    return @(attributeValue.data());
  return nil;
}

◆ initWithNode:

- (instancetype) initWithNode: (ui::AXPlatformNodeBase*) node

Definition at line 359 of file ax_platform_node_mac.mm.

                            :(ui::AXPlatformNodeBase*)node {
  if ((self = [super init])) {
    _node = node;
  }
  return self;
}

◆ isAccessibilityElement

- (BOOL) isAccessibilityElement

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                               {
  if (!_node)
    return NO;
  return (![[self AXRoleInternal] isEqualToString:NSAccessibilityUnknownRole] &&
          !_node->GetData().HasState(ax::mojom::State::kInvisible));
}

◆ isAccessibilityEnabled

- (BOOL) isAccessibilityEnabled

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                               {
  return [[self AXEnabledInternal] boolValue];
}

◆ isAccessibilityFocused

- (BOOL) isAccessibilityFocused

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                               {
  return [[self AXFocusedInternal] boolValue];
}

◆ isAccessibilitySelectorAllowed:

- (BOOL) isAccessibilitySelectorAllowed: (SEL) selector

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                      :(SEL)selector {
  if (!_node)
    return NO;
 
  const ax::mojom::Restriction restriction = _node->GetData().GetRestriction();
  if (restriction == ax::mojom::Restriction::kDisabled)
    return NO;
 
  if (selector == @selector(setAccessibilityValue:)) {
    // Tabs use the radio button role on Mac, so they are selected by calling
    // setSelected on an individual tab, rather than by setting the selected
    // element on the tabstrip as a whole.
    if (_node->GetData().role == ax::mojom::Role::kTab) {
      return !_node->GetData().GetBoolAttribute(ax::mojom::BoolAttribute::kSelected);
    }
    return restriction != ax::mojom::Restriction::kReadOnly;
  }
 
  // TODO(https://crbug.com/692362): Once the underlying bug in
  // views::Textfield::SetSelectionRange() described in that bug is fixed,
  // remove the check here; right now, this check serves to prevent
  // accessibility clients from trying to set the selection range, which won't
  // work because of 692362.
  if (selector == @selector(setAccessibilitySelectedText:) ||
      selector == @selector(setAccessibilitySelectedTextRange:) ||
      selector == @selector(setAccessibilitySelectedTextMarkerRange:)) {
    return restriction != ax::mojom::Restriction::kReadOnly;
  }
 
  if (selector == @selector(setAccessibilityFocused:))
    return _node->GetData().HasState(ax::mojom::State::kFocusable);
 
  // TODO(https://crbug.com/386671): What about role-specific selectors?
  return [super isAccessibilitySelectorAllowed:selector];
}

◆ nativeNotificationFromAXEvent:

+ (NSString *) nativeNotificationFromAXEvent: (ax::mojom::Event) event

Definition at line 359 of file ax_platform_node_mac.mm.

                                          :(ax::mojom::Event)event {
  static const base::NoDestructor<EventMap> event_map(BuildEventMap());
  EventMap::const_iterator it = event_map->find(event);
  return it != event_map->end() ? it->second : nil;
}

◆ nativeRoleFromAXRole:

+ (NSString *) nativeRoleFromAXRole: (ax::mojom::Role) role

Definition at line 359 of file ax_platform_node_mac.mm.

                                 :(ax::mojom::Role)role {
  static const base::NoDestructor<RoleMap> role_map(BuildRoleMap());
  RoleMap::const_iterator it = role_map->find(role);
  return it != role_map->end() ? it->second : NSAccessibilityUnknownRole;
}

◆ nativeSubroleFromAXRole:

+ (NSString *) nativeSubroleFromAXRole: (ax::mojom::Role) role

Definition at line 359 of file ax_platform_node_mac.mm.

                                    :(ax::mojom::Role)role {
  static const base::NoDestructor<RoleMap> subrole_map(BuildSubroleMap());
  RoleMap::const_iterator it = subrole_map->find(role);
  return it != subrole_map->end() ? it->second : nil;
}

◆ scheduleLiveRegionAnnouncement:

- (void) scheduleLiveRegionAnnouncement: (std::unique_ptr<AnnouncementSpec>) announcement

implementation

Provided by category AXPlatformNodeCocoa(Private).

Definition at line 359 of file ax_platform_node_mac.mm.

                                      :(std::unique_ptr<AnnouncementSpec>)announcement {
  if (_pendingAnnouncement) {
    // An announcement is already in flight, so just reset the contents. This is
    // threadsafe because the dispatch is on the main queue.
    _pendingAnnouncement = std::move(announcement);
    return;
  }
 
  _pendingAnnouncement = std::move(announcement);
  dispatch_after(kLiveRegionDebounceMillis * NSEC_PER_MSEC, dispatch_get_main_queue(), ^{
    if (!_pendingAnnouncement) {
      return;
    }
    PostAnnouncementNotification(_pendingAnnouncement->announcement, _pendingAnnouncement->window,
                                 _pendingAnnouncement->is_polite);
    _pendingAnnouncement.reset();
  });
}

◆ setAccessibilityFocused:

- (void) setAccessibilityFocused: (BOOL) isFocused

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                               :(BOOL)isFocused {
  if (!_node)
    return;
  ui::AXActionData data;
  data.action = isFocused ? ax::mojom::Action::kFocus : ax::mojom::Action::kBlur;
  _node->GetDelegate()->AccessibilityPerformAction(data);
}

◆ setAccessibilitySelectedText:

- (void) setAccessibilitySelectedText: (NSString*) text

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                    :(NSString*)text {
  if (!_node)
    return;
  ui::AXActionData data;
  data.action = ax::mojom::Action::kReplaceSelectedText;
  data.value = std::string([text UTF8String]);
 
  _node->GetDelegate()->AccessibilityPerformAction(data);
}

◆ setAccessibilitySelectedTextRange:

- (void) setAccessibilitySelectedTextRange: (NSRange) range

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                                         :(NSRange)range {
  if (!_node)
    return;
  ui::AXActionData data;
  data.action = ax::mojom::Action::kSetSelection;
  data.anchor_offset = range.location;
  data.focus_offset = NSMaxRange(range);
  _node->GetDelegate()->AccessibilityPerformAction(data);
}

◆ setAccessibilityValue:

- (void) setAccessibilityValue: (id) value

implementation

Definition at line 359 of file ax_platform_node_mac.mm.

                             :(id)value {
  if (!_node)
    return;
 
  ui::AXActionData data;
  data.action = _node->GetData().role == ax::mojom::Role::kTab ? ax::mojom::Action::kSetSelection
                                                               : ax::mojom::Action::kSetValue;
  if ([value isKindOfClass:[NSString class]]) {
    data.value = std::string([value UTF8String]);
  } else if ([value isKindOfClass:[NSValue class]]) {
    // TODO(https://crbug.com/386671): Is this case actually needed? The
    // NSObject accessibility implementation supported this, but can it actually
    // occur?
    NSRange range = [value rangeValue];
    data.anchor_offset = range.location;
    data.focus_offset = NSMaxRange(range);
  }
  _node->GetDelegate()->AccessibilityPerformAction(data);
}

Property Documentation

◆ boundsInScreen

- (NSRect) boundsInScreen

readnonatomicassign

Definition at line 69 of file ax_platform_node_mac.h.

◆ node

- (AXPlatformNodeBase*) AXPlatformNodeCocoa:

readnonatomicassign

Definition at line 70 of file ax_platform_node_mac.h.

The documentation for this class was generated from the following files:

third_party/accessibility/ax/platform/ax_platform_node_mac.h
third_party/accessibility/ax/platform/ax_platform_node_mac.mm

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ accessibilityActionNames

◆ accessibilityApplicationFocusedUIElement

◆ accessibilityAttributedStringForRange:

◆ accessibilityChildren

◆ accessibilityFocusedUIElement

◆ accessibilityFocusedWindow

◆ accessibilityFrame

◆ accessibilityFrameForRange:

◆ accessibilityHelp

◆ accessibilityHitTest:

◆ accessibilityInsertionPointLineNumber

◆ accessibilityIsIgnored

◆ accessibilityLabel

◆ accessibilityLineForIndex:

◆ accessibilityNotifiesWhenDestroyed

◆ accessibilityNumberOfCharacters

◆ accessibilityParent

◆ accessibilityPerformAction:

◆ accessibilityPlaceholderValue

◆ accessibilityRangeForIndex:

◆ accessibilityRangeForLine:

◆ accessibilityRangeForPosition:

◆ accessibilityRole

◆ accessibilityRoleDescription

◆ accessibilityRTFForRange:

◆ accessibilitySelected

◆ accessibilitySelectedText

◆ accessibilitySelectedTextRange

◆ accessibilitySelectedTextRanges

◆ accessibilitySharedCharacterRange

◆ accessibilitySharedFocusElements

◆ accessibilitySharedTextUIElements

◆ accessibilityStringForRange:

◆ accessibilityStyleRangeForIndex:

◆ accessibilitySubrole

◆ accessibilityTitle

◆ accessibilityTopLevelUIElement

◆ accessibilityValue

◆ accessibilityVisibleCharacterRange

◆ accessibilityWindow

◆ announcementForEvent:

◆ AXChildrenInternal

◆ AXEnabledInternal

◆ AXFocusedInternal

◆ AXHelpInternal

◆ AXInsertionPointLineNumberInternal

◆ AXMenuItemMarkChar

◆ AXNumberOfCharactersInternal

◆ AXParentInternal

◆ AXPlaceholderValueInternal

◆ AXPositionInternal

◆ AXRoleDescriptionInternal

◆ AXRoleInternal

◆ AXSelectedInternal

◆ AXSelectedTextInternal

◆ AXSelectedTextRangeInternal

◆ AXSizeInternal

◆ AXSubroleInternal

◆ AXTitleInternal

◆ AXTopLevelUIElementInternal

◆ AXValueInternal

◆ AXVisibleCharacterRangeInternal

◆ AXWindowInternal

◆ description

◆ detach

◆ getAXValueAsString

◆ getName

◆ getStringAttribute:

◆ initWithNode:

◆ isAccessibilityElement

◆ isAccessibilityEnabled

◆ isAccessibilityFocused

◆ isAccessibilitySelectorAllowed:

◆ nativeNotificationFromAXEvent:

◆ nativeRoleFromAXRole: