accessible/mac/mozActionElements.mm

   1 /* -*- Mode: Objective-C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #import "mozActionElements.h"
   7
   8 #import "MacUtils.h"
   9 #include "Accessible-inl.h"
  10 #include "DocAccessible.h"
  11 #include "XULTabAccessible.h"
  12
  13 #include "nsDeckFrame.h"
  14 #include "nsObjCExceptions.h"
  15
  16 using namespace mozilla::a11y;
  17
  18 enum CheckboxValue {
  19   // these constants correspond to the values in the OS
  20   kUnchecked = 0,
  21   kChecked = 1,
  22   kMixed = 2
  23 };
  24
  25 @implementation mozButtonAccessible
  26
  27 - (NSArray*)accessibilityAttributeNames
  28 {
  29   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
  30
  31   static NSArray *attributes = nil;
  32   if (!attributes) {
  33     attributes = [[NSArray alloc] initWithObjects:NSAccessibilityParentAttribute, // required
  34                                                   NSAccessibilityRoleAttribute, // required
  35                                                   NSAccessibilityRoleDescriptionAttribute,
  36                                                   NSAccessibilityPositionAttribute, // required
  37                                                   NSAccessibilitySizeAttribute, // required
  38                                                   NSAccessibilityWindowAttribute, // required
  39                                                   NSAccessibilityPositionAttribute, // required
  40                                                   NSAccessibilityTopLevelUIElementAttribute, // required
  41                                                   NSAccessibilityHelpAttribute,
  42                                                   NSAccessibilityEnabledAttribute, // required
  43                                                   NSAccessibilityFocusedAttribute, // required
  44                                                   NSAccessibilityTitleAttribute, // required
  45                                                   NSAccessibilityDescriptionAttribute,
  46 #if DEBUG
  47                                                   @"AXMozDescription",
  48 #endif
  49                                                   nil];
  50   }
  51   return attributes;
  52
  53   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
  54 }
  55
  56 - (id)accessibilityAttributeValue:(NSString *)attribute
  57 {
  58   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
  59
  60   if ([attribute isEqualToString:NSAccessibilityChildrenAttribute])
  61     return nil;
  62   if ([attribute isEqualToString:NSAccessibilityRoleDescriptionAttribute]) {
  63     if ([self isTab])
  64       return utils::LocalizedString(NS_LITERAL_STRING("tab"));
  65
  66     return NSAccessibilityRoleDescription([self role], nil);
  67   }
  68
  69   return [super accessibilityAttributeValue:attribute];
  70
  71   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
  72 }
  73
  74 - (BOOL)accessibilityIsIgnored
  75 {
  76   return !mGeckoAccessible;
  77 }
  78
  79 - (NSArray*)accessibilityActionNames
  80 {
  81   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
  82
  83   if ([self isEnabled])
  84     return [NSArray arrayWithObject:NSAccessibilityPressAction];
  85
  86   return nil;
  87
  88   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
  89 }
  90
  91 - (NSString*)accessibilityActionDescription:(NSString*)action
  92 {
  93   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
  94
  95   if ([action isEqualToString:NSAccessibilityPressAction]) {
  96     if ([self isTab])
  97       return utils::LocalizedString(NS_LITERAL_STRING("switch"));
  98
  99     return @"press button"; // XXX: localize this later?
 100   }
 101
 102   return nil;
 103
 104   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 105 }
 106
 107 - (void)accessibilityPerformAction:(NSString*)action
 108 {
 109   NS_OBJC_BEGIN_TRY_ABORT_BLOCK;
 110
 111   if ([action isEqualToString:NSAccessibilityPressAction])
 112     [self click];
 113
 114   NS_OBJC_END_TRY_ABORT_BLOCK;
 115 }
 116
 117 - (void)click
 118 {
 119   // both buttons and checkboxes have only one action. we should really stop using arbitrary
 120   // arrays with actions, and define constants for these actions.
 121   mGeckoAccessible->DoAction(0);
 122 }
 123
 124 - (BOOL)isTab
 125 {
 126   return (mGeckoAccessible && (mGeckoAccessible->Role() == roles::PAGETAB));
 127 }
 128
 129 @end
 130
 131 @implementation mozCheckboxAccessible
 132
 133 - (NSString*)accessibilityActionDescription:(NSString*)action
 134 {
 135   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
 136
 137   if ([action isEqualToString:NSAccessibilityPressAction]) {
 138     if ([self isChecked] != kUnchecked)
 139       return @"uncheck checkbox"; // XXX: localize this later?
 140
 141     return @"check checkbox"; // XXX: localize this later?
 142   }
 143
 144   return nil;
 145
 146   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 147 }
 148
 149 - (int)isChecked
 150 {
 151   uint64_t state = mGeckoAccessible->NativeState();
 152
 153   // check if we're checked or in a mixed state
 154   if (state & states::CHECKED) {
 155     return (state & states::MIXED) ? kMixed : kChecked;
 156   }
 157
 158   return kUnchecked;
 159 }
 160
 161 - (id)value
 162 {
 163   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
 164
 165   return [NSNumber numberWithInt:[self isChecked]];
 166
 167   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 168 }
 169
 170 @end
 171
 172 @implementation mozPopupButtonAccessible
 173
 174 - (NSArray *)accessibilityAttributeNames
 175 {
 176   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
 177
 178   static NSArray *attributes = nil;
 179
 180   if (!attributes) {
 181     attributes = [[NSArray alloc] initWithObjects:NSAccessibilityParentAttribute, // required
 182                                                   NSAccessibilityPositionAttribute, // required
 183                                                   NSAccessibilityRoleAttribute, // required
 184                                                   NSAccessibilitySizeAttribute, // required
 185                                                   NSAccessibilityWindowAttribute, // required
 186                                                   NSAccessibilityTopLevelUIElementAttribute, // required
 187                                                   NSAccessibilityHelpAttribute,
 188                                                   NSAccessibilityEnabledAttribute, // required
 189                                                   NSAccessibilityFocusedAttribute, // required
 190                                                   NSAccessibilityTitleAttribute, // required for popupmenus, and for menubuttons with a title
 191                                                   NSAccessibilityChildrenAttribute, // required
 192                                                   NSAccessibilityDescriptionAttribute, // required if it has no title attr
 193 #if DEBUG
 194                                                   @"AXMozDescription",
 195 #endif
 196                                                   nil];
 197   }
 198   return attributes;
 199
 200   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 201 }
 202
 203 - (id)accessibilityAttributeValue:(NSString *)attribute
 204 {
 205   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
 206
 207   if ([attribute isEqualToString:NSAccessibilityChildrenAttribute]) {
 208     return [super children];
 209   }
 210   return [super accessibilityAttributeValue:attribute];
 211
 212   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 213 }
 214
 215 - (NSArray *)accessibilityActionNames
 216 {
 217   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
 218
 219   if ([self isEnabled]) {
 220     return [NSArray arrayWithObjects:NSAccessibilityPressAction,
 221                                      NSAccessibilityShowMenuAction,
 222                                      nil];
 223   }
 224   return nil;
 225
 226   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 227 }
 228
 229 - (NSString *)accessibilityActionDescription:(NSString *)action
 230 {
 231   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
 232
 233   if ([action isEqualToString:NSAccessibilityShowMenuAction])
 234     return @"show menu";
 235   return [super accessibilityActionDescription:action];
 236
 237   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 238 }
 239
 240 - (void)accessibilityPerformAction:(NSString *)action
 241 {
 242   NS_OBJC_BEGIN_TRY_ABORT_BLOCK;
 243
 244   // both the ShowMenu and Click action do the same thing.
 245   if ([self isEnabled]) {
 246     // TODO: this should bring up the menu, but currently doesn't.
 247     //       once msaa and atk have merged better, they will implement
 248     //       the action needed to show the menu.
 249     [super click];
 250   }
 251
 252   NS_OBJC_END_TRY_ABORT_BLOCK;
 253 }
 254
 255 @end
 256
 257 @implementation mozTabsAccessible
 258
 259 - (void)dealloc
 260 {
 261   [mTabs release];
 262
 263   [super dealloc];
 264 }
 265
 266 - (NSArray*)accessibilityAttributeNames
 267 {
 268   // standard attributes that are shared and supported by root accessible (AXMain) elements.
 269   static NSMutableArray* attributes = nil;
 270
 271   if (!attributes) {
 272     attributes = [[super accessibilityAttributeNames] mutableCopy];
 273     [attributes addObject:NSAccessibilityContentsAttribute];
 274     [attributes addObject:NSAccessibilityTabsAttribute];
 275   }
 276
 277   return attributes;
 278 }
 279
 280 - (id)accessibilityAttributeValue:(NSString *)attribute
 281 {
 282   if ([attribute isEqualToString:NSAccessibilityContentsAttribute])
 283     return [super children];
 284   if ([attribute isEqualToString:NSAccessibilityTabsAttribute])
 285     return [self tabs];
 286
 287   return [super accessibilityAttributeValue:attribute];
 288 }
 289
 290 /**
 291  * Returns the selected tab (the mozAccessible)
 292  */
 293 - (id)value
 294 {
 295   if (!mGeckoAccessible)
 296     return nil;
 297
 298   Accessible* accessible = mGeckoAccessible->GetSelectedItem(0);
 299   if (!accessible)
 300     return nil;
 301
 302   mozAccessible* nativeAcc = nil;
 303   accessible->GetNativeInterface((void**)&nativeAcc);
 304
 305   return nativeAcc;
 306 }
 307
 308 /**
 309  * Return the mozAccessibles that are the tabs.
 310  */
 311 - (id)tabs
 312 {
 313   if (mTabs)
 314     return mTabs;
 315
 316   NSArray* children = [self children];
 317   NSEnumerator* enumerator = [children objectEnumerator];
 318   mTabs = [[NSMutableArray alloc] init];
 319
 320   id obj;
 321   while ((obj = [enumerator nextObject]))
 322     if ([obj isTab])
 323       [mTabs addObject:obj];
 324
 325   return mTabs;
 326 }
 327
 328 - (void)invalidateChildren
 329 {
 330   [super invalidateChildren];
 331
 332   [mTabs release];
 333   mTabs = nil;
 334 }
 335
 336 @end
 337
 338 @implementation mozPaneAccessible
 339
 340 - (NSUInteger)accessibilityArrayAttributeCount:(NSString*)attribute
 341 {
 342   if (!mGeckoAccessible)
 343     return 0;
 344
 345   // By default this calls -[[mozAccessible children] count].
 346   // Since we don't cache mChildren. This is faster.
 347   if ([attribute isEqualToString:NSAccessibilityChildrenAttribute])
 348     return mGeckoAccessible->ChildCount() ? 1 : 0;
 349
 350   return [super accessibilityArrayAttributeCount:attribute];
 351 }
 352
 353 - (NSArray*)children
 354 {
 355   if (!mGeckoAccessible)
 356     return nil;
 357
 358   nsDeckFrame* deckFrame = do_QueryFrame(mGeckoAccessible->GetFrame());
 359   nsIFrame* selectedFrame = deckFrame ? deckFrame->GetSelectedBox() : nullptr;
 360
 361   Accessible* selectedAcc = nullptr;
 362   if (selectedFrame) {
 363     nsINode* node = selectedFrame->GetContent();
 364     selectedAcc = mGeckoAccessible->Document()->GetAccessible(node);
 365   }
 366
 367   if (selectedAcc) {
 368     mozAccessible *curNative = GetNativeFromGeckoAccessible(selectedAcc);
 369     if (curNative)
 370       return [NSArray arrayWithObjects:GetObjectOrRepresentedView(curNative), nil];
 371   }
 372
 373   return nil;
 374 }
 375
 376 @end