accessible/mac/MOXAccessibleProtocol.h

   1 /* clang-format off */
   2 /* -*- Mode: Objective-C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   3 /* clang-format on */
   4 /* This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   7
   8 @protocol MOXTextMarkerSupport;
   9
  10 // This protocol's primary use is for abstracting the NSAccessibility informal
  11 // protocol into a formal internal API. Conforming classes get to choose a
  12 // subset of the optional methods to implement. Those methods will be mapped to
  13 // NSAccessibility attributes or actions. A conforming class can implement
  14 // moxBlockSelector to control which of its implemented methods should be
  15 // exposed to NSAccessibility.
  16
  17 @protocol MOXAccessible
  18
  19 // The deepest descendant of the accessible subtree that contains the specified
  20 // point. Forwarded from accessibilityHitTest.
  21 - (id _Nullable)moxHitTest:(NSPoint)point;
  22
  23 // The deepest descendant of the accessible subtree that has the focus.
  24 // Forwarded from accessibilityFocusedUIElement.
  25 - (id _Nullable)moxFocusedUIElement;
  26
  27 // Sends a notification to any observing assistive applications.
  28 - (void)moxPostNotification:(NSString* _Nonnull)notification;
  29
  30 - (void)moxPostNotification:(NSString* _Nonnull)notification
  31                withUserInfo:(NSDictionary* _Nullable)userInfo;
  32
  33 // Return YES if selector should be considered not supported.
  34 // Used in implementations such as:
  35 // - accessibilityAttributeNames
  36 // - accessibilityActionNames
  37 // - accessibilityIsAttributeSettable
  38 - (BOOL)moxBlockSelector:(SEL _Nonnull)selector;
  39
  40 // Returns a list of all children, doesn't do ignore filtering.
  41 - (NSArray* _Nullable)moxChildren;
  42
  43 // Returns our parent, doesn't do ignore filtering.
  44 - (id<mozAccessible> _Nullable)moxParent;
  45
  46 // This is called by isAccessibilityElement. If a subclass wants
  47 // to alter the isAccessibilityElement return value, it must
  48 // override this and not isAccessibilityElement directly.
  49 - (BOOL)moxIgnoreWithParent:(id<MOXAccessible> _Nullable)parent;
  50
  51 // Should the child be ignored. This allows subclasses to determine
  52 // what kinds of accessibles are valid children. This causes the child
  53 // to be skipped, but the unignored descendants will be added to the
  54 // container in the default children getter.
  55 - (BOOL)moxIgnoreChild:(id<MOXAccessible> _Nullable)child;
  56
  57 // Return text delegate if it exists.
  58 - (id<MOXTextMarkerSupport> _Nullable)moxTextMarkerDelegate;
  59
  60 // Return true if this accessible is a live region
  61 - (BOOL)moxIsLiveRegion;
  62
  63 // Find the nearest ancestor that returns true with the given block function
  64 - (id<MOXAccessible> _Nullable)moxFindAncestor:
  65     (BOOL (^_Nonnull)(id<MOXAccessible> _Nonnull moxAcc,
  66                       BOOL* _Nonnull stop))findBlock;
  67
  68 @optional
  69
  70 #pragma mark - AttributeGetters
  71
  72 // AXChildren
  73 - (NSArray* _Nullable)moxUnignoredChildren;
  74
  75 // AXParent
  76 - (id _Nullable)moxUnignoredParent;
  77
  78 // AXRole
  79 - (NSString* _Nullable)moxRole;
  80
  81 // AXRoleDescription
  82 - (NSString* _Nullable)moxRoleDescription;
  83
  84 // AXSubrole
  85 - (NSString* _Nullable)moxSubrole;
  86
  87 // AXTitle
  88 - (NSString* _Nullable)moxTitle;
  89
  90 // AXDescription
  91 - (NSString* _Nullable)moxLabel;
  92
  93 // AXHelp
  94 - (NSString* _Nullable)moxHelp;
  95
  96 // AXValue
  97 - (id _Nullable)moxValue;
  98
  99 // AXSize
 100 - (NSValue* _Nullable)moxSize;
 101
 102 // AXPosition
 103 - (NSValue* _Nullable)moxPosition;
 104
 105 // AXEnabled
 106 - (NSNumber* _Nullable)moxEnabled;
 107
 108 // AXFocused
 109 - (NSNumber* _Nullable)moxFocused;
 110
 111 // AXWindow
 112 - (id _Nullable)moxWindow;
 113
 114 // AXFrame
 115 - (NSValue* _Nullable)moxFrame;
 116
 117 // AXTitleUIElement
 118 - (id _Nullable)moxTitleUIElement;
 119
 120 // AXTopLevelUIElement
 121 - (id _Nullable)moxTopLevelUIElement;
 122
 123 // AXHasPopup
 124 - (NSNumber* _Nullable)moxHasPopup;
 125
 126 // AXARIACurrent
 127 - (NSString* _Nullable)moxARIACurrent;
 128
 129 // AXSelected
 130 - (NSNumber* _Nullable)moxSelected;
 131
 132 // AXRequired
 133 - (NSNumber* _Nullable)moxRequired;
 134
 135 // AXElementBusy
 136 - (NSNumber* _Nullable)moxElementBusy;
 137
 138 // AXLinkedUIElements
 139 - (NSArray* _Nullable)moxLinkedUIElements;
 140
 141 // AXARIAControls
 142 - (NSArray* _Nullable)moxARIAControls;
 143
 144 // AXDOMIdentifier
 145 - (NSString* _Nullable)moxDOMIdentifier;
 146
 147 // AXURL
 148 - (NSURL* _Nullable)moxURL;
 149
 150 // AXLinkUIElements
 151 - (NSArray* _Nullable)moxLinkUIElements;
 152
 153 // AXPopupValue
 154 - (NSString* _Nullable)moxPopupValue;
 155
 156 // AXVisited
 157 - (NSNumber* _Nullable)moxVisited;
 158
 159 // AXExpanded
 160 - (NSNumber* _Nullable)moxExpanded;
 161
 162 // AXMain
 163 - (NSNumber* _Nullable)moxMain;
 164
 165 // AXMinimized
 166 - (NSNumber* _Nullable)moxMinimized;
 167
 168 // AXSelectedChildren
 169 - (NSArray* _Nullable)moxSelectedChildren;
 170
 171 // AXTabs
 172 - (NSArray* _Nullable)moxTabs;
 173
 174 // AXContents
 175 - (NSArray* _Nullable)moxContents;
 176
 177 // AXOrientation
 178 - (NSString* _Nullable)moxOrientation;
 179
 180 // AXMenuItemMarkChar
 181 - (NSString* _Nullable)moxMenuItemMarkChar;
 182
 183 // AXLoaded
 184 - (NSNumber* _Nullable)moxLoaded;
 185
 186 // AXLoadingProgress
 187 - (NSNumber* _Nullable)moxLoadingProgress;
 188
 189 // Webkit also implements the following:
 190 // // AXCaretBrowsingEnabled
 191 // - (NSString* _Nullable)moxCaretBrowsingEnabled;
 192
 193 // // AXLayoutCount
 194 // - (NSString* _Nullable)moxLayoutCount;
 195
 196 // // AXWebSessionID
 197 // - (NSString* _Nullable)moxWebSessionID;
 198
 199 // // AXPreventKeyboardDOMEventDispatch
 200 // - (NSString* _Nullable)moxPreventKeyboardDOMEventDispatch;
 201
 202 // Table Attributes
 203
 204 // AXRowCount
 205 - (NSNumber* _Nullable)moxRowCount;
 206
 207 // AXColumnCount
 208 - (NSNumber* _Nullable)moxColumnCount;
 209
 210 // AXRows
 211 - (NSArray* _Nullable)moxRows;
 212
 213 // AXColumns
 214 - (NSArray* _Nullable)moxColumns;
 215
 216 // AXIndex
 217 - (NSNumber* _Nullable)moxIndex;
 218
 219 // AXRowIndexRange
 220 - (NSValue* _Nullable)moxRowIndexRange;
 221
 222 // AXColumnIndexRange
 223 - (NSValue* _Nullable)moxColumnIndexRange;
 224
 225 // AXRowHeaderUIElements
 226 - (NSArray* _Nullable)moxRowHeaderUIElements;
 227
 228 // AXColumnHeaderUIElements
 229 - (NSArray* _Nullable)moxColumnHeaderUIElements;
 230
 231 // AXIdentifier
 232 - (NSString* _Nullable)moxIdentifier;
 233
 234 // AXVisibleChildren
 235 - (NSArray* _Nullable)moxVisibleChildren;
 236
 237 // Outline Attributes
 238
 239 // AXDisclosing
 240 - (NSNumber* _Nullable)moxDisclosing;
 241
 242 // AXDisclosedByRow
 243 - (id _Nullable)moxDisclosedByRow;
 244
 245 // AXDisclosureLevel
 246 - (NSNumber* _Nullable)moxDisclosureLevel;
 247
 248 // AXDisclosedRows
 249 - (NSArray* _Nullable)moxDisclosedRows;
 250
 251 // AXSelectedRows
 252 - (NSArray* _Nullable)moxSelectedRows;
 253
 254 // Math Attributes
 255
 256 // AXMathRootRadicand
 257 - (id _Nullable)moxMathRootRadicand;
 258
 259 // AXMathRootIndex
 260 - (id _Nullable)moxMathRootIndex;
 261
 262 // AXMathFractionNumerator
 263 - (id _Nullable)moxMathFractionNumerator;
 264
 265 // AXMathFractionDenominator
 266 - (id _Nullable)moxMathFractionDenominator;
 267
 268 // AXMathLineThickness
 269 - (NSNumber* _Nullable)moxMathLineThickness;
 270
 271 // AXMathBase
 272 - (id _Nullable)moxMathBase;
 273
 274 // AXMathSubscript
 275 - (id _Nullable)moxMathSubscript;
 276
 277 // AXMathSuperscript
 278 - (id _Nullable)moxMathSuperscript;
 279
 280 // AXMathUnder
 281 - (id _Nullable)moxMathUnder;
 282
 283 // AXMathOver
 284 - (id _Nullable)moxMathOver;
 285
 286 // AXInvalid
 287 - (NSString* _Nullable)moxInvalid;
 288
 289 // AXSelectedText
 290 - (NSString* _Nullable)moxSelectedText;
 291
 292 // AXSelectedTextRange
 293 - (NSValue* _Nullable)moxSelectedTextRange;
 294
 295 // AXNumberOfCharacters
 296 - (NSNumber* _Nullable)moxNumberOfCharacters;
 297
 298 // AXVisibleCharacterRange
 299 - (NSValue* _Nullable)moxVisibleCharacterRange;
 300
 301 // AXInsertionPointLineNumber
 302 - (NSNumber* _Nullable)moxInsertionPointLineNumber;
 303
 304 // AXEditableAncestor
 305 - (id _Nullable)moxEditableAncestor;
 306
 307 // AXHighestEditableAncestor
 308 - (id _Nullable)moxHighestEditableAncestor;
 309
 310 // AXFocusableAncestor
 311 - (id _Nullable)moxFocusableAncestor;
 312
 313 // AXARIAAtomic
 314 - (NSNumber* _Nullable)moxARIAAtomic;
 315
 316 // AXARIALive
 317 - (NSString* _Nullable)moxARIALive;
 318
 319 // AXARIARelevant
 320 - (NSString* _Nullable)moxARIARelevant;
 321
 322 // AXMozDebugDescription
 323 - (NSString* _Nullable)moxMozDebugDescription;
 324
 325 #pragma mark - AttributeSetters
 326
 327 // AXDisclosing
 328 - (void)moxSetDisclosing:(NSNumber* _Nullable)disclosing;
 329
 330 // AXValue
 331 - (void)moxSetValue:(id _Nullable)value;
 332
 333 // AXFocused
 334 - (void)moxSetFocused:(NSNumber* _Nullable)focused;
 335
 336 // AXSelected
 337 - (void)moxSetSelected:(NSNumber* _Nullable)selected;
 338
 339 // AXSelectedChildren
 340 - (void)moxSetSelectedChildren:(NSArray* _Nullable)selectedChildren;
 341
 342 // AXSelectedText
 343 - (void)moxSetSelectedText:(NSString* _Nullable)selectedText;
 344
 345 // AXSelectedTextRange
 346 - (void)moxSetSelectedTextRange:(NSValue* _Nullable)selectedTextRange;
 347
 348 // AXVisibleCharacterRange
 349 - (void)moxSetVisibleCharacterRange:(NSValue* _Nullable)visibleCharacterRange;
 350
 351 #pragma mark - Actions
 352
 353 // AXPress
 354 - (void)moxPerformPress;
 355
 356 // AXShowMenu
 357 - (void)moxPerformShowMenu;
 358
 359 // AXScrollToVisible
 360 - (void)moxPerformScrollToVisible;
 361
 362 // AXIncrement
 363 - (void)moxPerformIncrement;
 364
 365 // AXDecrement
 366 - (void)moxPerformDecrement;
 367
 368 #pragma mark - ParameterizedAttributeGetters
 369
 370 // AXLineForIndex
 371 - (NSNumber* _Nullable)moxLineForIndex:(NSNumber* _Nonnull)index;
 372
 373 // AXRangeForLine
 374 - (NSValue* _Nullable)moxRangeForLine:(NSNumber* _Nonnull)line;
 375
 376 // AXStringForRange
 377 - (NSString* _Nullable)moxStringForRange:(NSValue* _Nonnull)range;
 378
 379 // AXRangeForPosition
 380 - (NSValue* _Nullable)moxRangeForPosition:(NSValue* _Nonnull)position;
 381
 382 // AXRangeForIndex
 383 - (NSValue* _Nullable)moxRangeForIndex:(NSNumber* _Nonnull)index;
 384
 385 // AXBoundsForRange
 386 - (NSValue* _Nullable)moxBoundsForRange:(NSValue* _Nonnull)range;
 387
 388 // AXRTFForRange
 389 - (NSData* _Nullable)moxRTFForRange:(NSValue* _Nonnull)range;
 390
 391 // AXStyleRangeForIndex
 392 - (NSValue* _Nullable)moxStyleRangeForIndex:(NSNumber* _Nonnull)index;
 393
 394 // AXAttributedStringForRange
 395 - (NSAttributedString* _Nullable)moxAttributedStringForRange:
 396     (NSValue* _Nonnull)range;
 397
 398 // AXUIElementsForSearchPredicate
 399 - (NSArray* _Nullable)moxUIElementsForSearchPredicate:
 400     (NSDictionary* _Nonnull)searchPredicate;
 401
 402 // AXUIElementCountForSearchPredicate
 403 - (NSNumber* _Nullable)moxUIElementCountForSearchPredicate:
 404     (NSDictionary* _Nonnull)searchPredicate;
 405
 406 // AXCellForColumnAndRow
 407 - (id _Nullable)moxCellForColumnAndRow:(NSArray* _Nonnull)columnAndRow;
 408
 409 // AXIndexForChildUIElement
 410 - (NSNumber* _Nullable)moxIndexForChildUIElement:(id _Nonnull)child;
 411
 412 @end
 413
 414 // This protocol maps text marker and text marker range parameters to
 415 // methods. It is implemented by a delegate of a MOXAccessible.
 416 @protocol MOXTextMarkerSupport
 417
 418 #pragma mark - TextAttributeGetters
 419
 420 // AXStartTextMarker
 421 - (id _Nullable)moxStartTextMarker;
 422
 423 // AXEndTextMarker
 424 - (id _Nullable)moxEndTextMarker;
 425
 426 // AXSelectedTextMarkerRange
 427 - (id _Nullable)moxSelectedTextMarkerRange;
 428
 429 #pragma mark - ParameterizedTextAttributeGetters
 430
 431 // AXLengthForTextMarkerRange
 432 - (NSNumber* _Nullable)moxLengthForTextMarkerRange:(id _Nonnull)textMarkerRange;
 433
 434 // AXStringForTextMarkerRange
 435 - (NSString* _Nullable)moxStringForTextMarkerRange:(id _Nonnull)textMarkerRange;
 436
 437 // AXTextMarkerRangeForUnorderedTextMarkers
 438 - (id _Nullable)moxTextMarkerRangeForUnorderedTextMarkers:
 439     (NSArray* _Nonnull)textMarkers;
 440
 441 // AXLeftWordTextMarkerRangeForTextMarker
 442 - (id _Nullable)moxLeftWordTextMarkerRangeForTextMarker:(id _Nonnull)textMarker;
 443
 444 // AXRightWordTextMarkerRangeForTextMarker
 445 - (id _Nullable)moxRightWordTextMarkerRangeForTextMarker:
 446     (id _Nonnull)textMarker;
 447
 448 // AXStartTextMarkerForTextMarkerRange
 449 - (id _Nullable)moxStartTextMarkerForTextMarkerRange:
 450     (id _Nonnull)textMarkerRange;
 451
 452 // AXEndTextMarkerForTextMarkerRange
 453 - (id _Nullable)moxEndTextMarkerForTextMarkerRange:(id _Nonnull)textMarkerRange;
 454
 455 // AXNextTextMarkerForTextMarker
 456 - (id _Nullable)moxNextTextMarkerForTextMarker:(id _Nonnull)textMarker;
 457
 458 // AXPreviousTextMarkerForTextMarker
 459 - (id _Nullable)moxPreviousTextMarkerForTextMarker:(id _Nonnull)textMarker;
 460
 461 // AXAttributedStringForTextMarkerRange
 462 - (NSAttributedString* _Nullable)moxAttributedStringForTextMarkerRange:
 463     (id _Nonnull)textMarkerRange;
 464
 465 // AXBoundsForTextMarkerRange
 466 - (NSValue* _Nullable)moxBoundsForTextMarkerRange:(id _Nonnull)textMarkerRange;
 467
 468 // AXIndexForTextMarker
 469 - (NSNumber* _Nullable)moxIndexForTextMarker:(id _Nonnull)textMarker;
 470
 471 // AXTextMarkerForIndex
 472 - (id _Nullable)moxTextMarkerForIndex:(NSNumber* _Nonnull)index;
 473
 474 // AXUIElementForTextMarker
 475 - (id _Nullable)moxUIElementForTextMarker:(id _Nonnull)textMarker;
 476
 477 // AXTextMarkerRangeForUIElement
 478 - (id _Nullable)moxTextMarkerRangeForUIElement:(id _Nonnull)element;
 479
 480 // AXLineTextMarkerRangeForTextMarker
 481 - (id _Nullable)moxLineTextMarkerRangeForTextMarker:(id _Nonnull)textMarker;
 482
 483 // AXLeftLineTextMarkerRangeForTextMarker
 484 - (id _Nullable)moxLeftLineTextMarkerRangeForTextMarker:(id _Nonnull)textMarker;
 485
 486 // AXRightLineTextMarkerRangeForTextMarker
 487 - (id _Nullable)moxRightLineTextMarkerRangeForTextMarker:
 488     (id _Nonnull)textMarker;
 489
 490 // AXParagraphTextMarkerRangeForTextMarker
 491 - (id _Nullable)moxParagraphTextMarkerRangeForTextMarker:
 492     (id _Nonnull)textMarker;
 493
 494 // AXStyleTextMarkerRangeForTextMarker
 495 - (id _Nullable)moxStyleTextMarkerRangeForTextMarker:(id _Nonnull)textMarker;
 496
 497 // AXMozDebugDescriptionForTextMarker
 498 - (NSString* _Nullable)moxMozDebugDescriptionForTextMarker:
 499     (id _Nonnull)textMarker;
 500
 501 // AXMozDebugDescriptionForTextMarkerRange
 502 - (NSString* _Nullable)moxMozDebugDescriptionForTextMarkerRange:
 503     (id _Nonnull)textMarkerRange;
 504
 505 #pragma mark - TextAttributeSetters
 506
 507 // AXSelectedTextMarkerRange
 508 - (void)moxSetSelectedTextMarkerRange:(id _Nullable)textMarkerRange;
 509
 510 @end