accessible/mac/mozAccessible.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 "AccessibleWrap.h"
   9 #include "RemoteAccessible.h"
  10
  11 #import <Cocoa/Cocoa.h>
  12
  13 #import "MOXAccessibleBase.h"
  14
  15 @class mozRootAccessible;
  16
  17 /**
  18  * All mozAccessibles are either abstract objects (that correspond to XUL
  19  * widgets, HTML frames, etc) or are attached to a certain view; for example
  20  * a document view. When we hand an object off to an AT, we always want
  21  * to give it the represented view, in the latter case.
  22  */
  23
  24 namespace mozilla {
  25 namespace a11y {
  26
  27 inline mozAccessible* GetNativeFromGeckoAccessible(
  28     mozilla::a11y::Accessible* aAcc) {
  29   if (!aAcc) {
  30     return nil;
  31   }
  32   if (LocalAccessible* acc = aAcc->AsLocal()) {
  33     mozAccessible* native = nil;
  34     acc->GetNativeInterface((void**)&native);
  35     return native;
  36   }
  37
  38   RemoteAccessible* proxy = aAcc->AsRemote();
  39   return reinterpret_cast<mozAccessible*>(proxy->GetWrapper());
  40 }
  41
  42 }  // a11y
  43 }  // mozilla
  44
  45 @interface mozAccessible : MOXAccessibleBase {
  46   /**
  47    * Reference to the accessible we were created with;
  48    * either a proxy accessible or an accessible wrap.
  49    */
  50   mozilla::a11y::Accessible* mGeckoAccessible;
  51
  52   /**
  53    * The role of our gecko accessible.
  54    */
  55   mozilla::a11y::role mRole;
  56
  57   /**
  58    * A cache of a subset of our states.
  59    */
  60   uint64_t mCachedState;
  61
  62   nsStaticAtom* mARIARole;
  63
  64   bool mIsLiveRegion;
  65 }
  66
  67 // inits with the given wrap or proxy accessible
  68 - (id)initWithAccessible:(mozilla::a11y::Accessible*)aAcc;
  69
  70 // allows for gecko accessible access outside of the class
  71 - (mozilla::a11y::Accessible*)geckoAccessible;
  72
  73 - (mozilla::a11y::Accessible*)geckoDocument;
  74
  75 // override
  76 - (void)dealloc;
  77
  78 // should a child be disabled
  79 - (BOOL)disableChild:(mozAccessible*)child;
  80
  81 // Given a gecko accessibility event type, post the relevant
  82 // system accessibility notification.
  83 // Note: when overriding or adding new events, make sure your events aren't
  84 // filtered out in Platform::ProxyEvent or AccessibleWrap::HandleAccEvent!
  85 - (void)handleAccessibleEvent:(uint32_t)eventType;
  86
  87 - (void)handleAccessibleTextChangeEvent:(NSString*)change
  88                                inserted:(BOOL)isInserted
  89                             inContainer:(mozilla::a11y::Accessible*)container
  90                                      at:(int32_t)start;
  91
  92 // internal method to retrieve a child at a given index.
  93 - (id)childAt:(uint32_t)i;
  94
  95 // Get gecko accessible's state.
  96 - (uint64_t)state;
  97
  98 // Get gecko accessible's state filtered through given mask.
  99 - (uint64_t)stateWithMask:(uint64_t)mask;
 100
 101 // Notify of a state change, so the cache can be altered.
 102 - (void)stateChanged:(uint64_t)state isEnabled:(BOOL)enabled;
 103
 104 // Invalidate cached state.
 105 - (void)invalidateState;
 106
 107 // Get top level (tab) web area.
 108 - (mozAccessible*)topWebArea;
 109
 110 // Handle a role change
 111 - (void)handleRoleChanged:(mozilla::a11y::role)newRole;
 112
 113 // Get ARIA role
 114 - (nsStaticAtom*)ARIARole;
 115
 116 // Get array of related mozAccessibles
 117 - (NSArray<mozAccessible*>*)getRelationsByType:
 118     (mozilla::a11y::RelationType)relationType;
 119
 120 #pragma mark - mozAccessible protocol / widget
 121
 122 // override
 123 - (BOOL)hasRepresentedView;
 124
 125 // override
 126 - (id)representedView;
 127
 128 // override
 129 - (BOOL)isRoot;
 130
 131 #pragma mark - MOXAccessible protocol
 132
 133 // override
 134 - (BOOL)moxBlockSelector:(SEL)selector;
 135
 136 // override
 137 - (id)moxHitTest:(NSPoint)point;
 138
 139 // override
 140 - (id)moxFocusedUIElement;
 141
 142 - (id<MOXTextMarkerSupport>)moxTextMarkerDelegate;
 143
 144 - (BOOL)moxIsLiveRegion;
 145
 146 // Attribute getters
 147
 148 // override
 149 - (id<mozAccessible>)moxParent;
 150
 151 // override
 152 - (NSArray*)moxChildren;
 153
 154 // override
 155 - (NSValue*)moxSize;
 156
 157 // override
 158 - (NSValue*)moxPosition;
 159
 160 // override
 161 - (NSString*)moxRole;
 162
 163 // override
 164 - (NSString*)moxSubrole;
 165
 166 // override
 167 - (NSString*)moxRoleDescription;
 168
 169 // override
 170 - (NSWindow*)moxWindow;
 171
 172 // override
 173 - (id)moxValue;
 174
 175 // override
 176 - (NSString*)moxTitle;
 177
 178 // override
 179 - (NSString*)moxLabel;
 180
 181 // override
 182 - (NSString*)moxHelp;
 183
 184 // override
 185 - (NSNumber*)moxEnabled;
 186
 187 // override
 188 - (NSNumber*)moxFocused;
 189
 190 // override
 191 - (NSNumber*)moxSelected;
 192
 193 // override
 194 - (NSNumber*)moxExpanded;
 195
 196 // override
 197 - (NSValue*)moxFrame;
 198
 199 // override
 200 - (NSString*)moxARIACurrent;
 201
 202 // override
 203 - (NSNumber*)moxARIAAtomic;
 204
 205 // override
 206 - (NSString*)moxARIALive;
 207
 208 // override
 209 - (NSString*)moxARIARelevant;
 210
 211 // override
 212 - (id)moxTitleUIElement;
 213
 214 // override
 215 - (NSString*)moxDOMIdentifier;
 216
 217 // override
 218 - (NSNumber*)moxRequired;
 219
 220 // override
 221 - (NSNumber*)moxElementBusy;
 222
 223 // override
 224 - (NSArray*)moxLinkedUIElements;
 225
 226 // override
 227 - (NSArray*)moxARIAControls;
 228
 229 // override
 230 - (id)moxEditableAncestor;
 231
 232 // override
 233 - (id)moxHighestEditableAncestor;
 234
 235 // override
 236 - (id)moxFocusableAncestor;
 237
 238 #ifndef RELEASE_OR_BETA
 239 // override
 240 - (NSString*)moxMozDebugDescription;
 241 #endif
 242
 243 // override
 244 - (NSArray*)moxUIElementsForSearchPredicate:(NSDictionary*)searchPredicate;
 245
 246 // override
 247 - (NSNumber*)moxUIElementCountForSearchPredicate:(NSDictionary*)searchPredicate;
 248
 249 // override
 250 - (void)moxSetFocused:(NSNumber*)focused;
 251
 252 // override
 253 - (void)moxPerformScrollToVisible;
 254
 255 // override
 256 - (void)moxPerformShowMenu;
 257
 258 // override
 259 - (void)moxPerformPress;
 260
 261 // override
 262 - (BOOL)moxIgnoreWithParent:(mozAccessible*)parent;
 263
 264 // override
 265 - (BOOL)moxIgnoreChild:(mozAccessible*)child;
 266
 267 #pragma mark -
 268
 269 // makes ourselves "expired". after this point, we might be around if someone
 270 // has retained us (e.g., a third-party), but we really contain no information.
 271 // override
 272 - (void)expire;
 273 // override
 274 - (BOOL)isExpired;
 275
 276 @end