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