accessible/public/nsIAccessibleEvent.idl

Thu, 15 Jan 2015 15:55:04 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 15 Jan 2015 15:55:04 +0100
branch
TOR_BUG_9701
changeset 9
a63d609f5ebe
permissions
-rw-r--r--

Back out 97036ab72558 which inappropriately compared turds to third parties.

michael@0 1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
michael@0 2 /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0 3 * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0 4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0 5
michael@0 6 #include "nsISupports.idl"
michael@0 7
michael@0 8 interface nsIAccessible;
michael@0 9 interface nsIAccessibleDocument;
michael@0 10 interface nsIDOMNode;
michael@0 11
michael@0 12 %{C++
michael@0 13 #define NS_ACCESSIBLE_EVENT_TOPIC "accessible-event"
michael@0 14 %}
michael@0 15
michael@0 16 /**
michael@0 17 * An interface for accessibility events listened to
michael@0 18 * by in-process accessibility clients, which can be used
michael@0 19 * to find out how to get accessibility and DOM interfaces for
michael@0 20 * the event and its target. To listen to in-process accessibility invents,
michael@0 21 * make your object an nsIObserver, and listen for accessible-event by
michael@0 22 * using code something like this:
michael@0 23 * nsCOMPtr<nsIObserverService> observerService =
michael@0 24 * do_GetService("@mozilla.org/observer-service;1", &rv);
michael@0 25 * if (NS_SUCCEEDED(rv))
michael@0 26 * rv = observerService->AddObserver(this, "accessible-event", PR_TRUE);
michael@0 27 */
michael@0 28 [scriptable, builtinclass, uuid(7f66a33a-9ed7-4fd4-87a8-e431b0f43368)]
michael@0 29 interface nsIAccessibleEvent : nsISupports
michael@0 30 {
michael@0 31 /**
michael@0 32 * An object has been created.
michael@0 33 */
michael@0 34 const unsigned long EVENT_SHOW = 0x0001;
michael@0 35
michael@0 36 /**
michael@0 37 * An object has been destroyed.
michael@0 38 */
michael@0 39 const unsigned long EVENT_HIDE = 0x0002;
michael@0 40
michael@0 41 /**
michael@0 42 * An object's children have changed
michael@0 43 */
michael@0 44 const unsigned long EVENT_REORDER = 0x0003;
michael@0 45
michael@0 46 /**
michael@0 47 * The active descendant of a component has changed. The active descendant
michael@0 48 * is used in objects with transient children.
michael@0 49 */
michael@0 50 const unsigned long EVENT_ACTIVE_DECENDENT_CHANGED = 0x0004;
michael@0 51
michael@0 52 /**
michael@0 53 * An object has received the keyboard focus.
michael@0 54 */
michael@0 55 const unsigned long EVENT_FOCUS = 0x0005;
michael@0 56
michael@0 57 /**
michael@0 58 * An object's state has changed.
michael@0 59 */
michael@0 60 const unsigned long EVENT_STATE_CHANGE = 0x0006;
michael@0 61
michael@0 62 /**
michael@0 63 * An object has changed location, shape, or size.
michael@0 64 */
michael@0 65 const unsigned long EVENT_LOCATION_CHANGE = 0x0007;
michael@0 66
michael@0 67 /**
michael@0 68 * An object's Name property has changed.
michael@0 69 */
michael@0 70 const unsigned long EVENT_NAME_CHANGE = 0x0008;
michael@0 71
michael@0 72 /**
michael@0 73 * An object's Description property has changed.
michael@0 74 */
michael@0 75 const unsigned long EVENT_DESCRIPTION_CHANGE = 0x0009;
michael@0 76
michael@0 77 /**
michael@0 78 * An object's Value property has changed.
michael@0 79 */
michael@0 80 const unsigned long EVENT_VALUE_CHANGE = 0x000A;
michael@0 81
michael@0 82 /**
michael@0 83 * An object's help has changed.
michael@0 84 */
michael@0 85 const unsigned long EVENT_HELP_CHANGE = 0x000B;
michael@0 86
michael@0 87 /**
michael@0 88 * An object's default action has changed.
michael@0 89 */
michael@0 90 const unsigned long EVENT_DEFACTION_CHANGE = 0x000C;
michael@0 91
michael@0 92 /**
michael@0 93 * An object's action has changed.
michael@0 94 */
michael@0 95 const unsigned long EVENT_ACTION_CHANGE = 0x000D;
michael@0 96
michael@0 97 /**
michael@0 98 * An object's keyboard shortcut has changed.
michael@0 99 */
michael@0 100 const unsigned long EVENT_ACCELERATOR_CHANGE = 0x000E;
michael@0 101
michael@0 102 /**
michael@0 103 * The selection within a container object has changed.
michael@0 104 */
michael@0 105 const unsigned long EVENT_SELECTION = 0x000F;
michael@0 106
michael@0 107 /**
michael@0 108 * An item within a container object has been added to the selection.
michael@0 109 */
michael@0 110 const unsigned long EVENT_SELECTION_ADD = 0x0010;
michael@0 111
michael@0 112 /**
michael@0 113 * An item within a container object has been removed from the selection.
michael@0 114 */
michael@0 115 const unsigned long EVENT_SELECTION_REMOVE = 0x0011;
michael@0 116
michael@0 117 /**
michael@0 118 * Numerous selection changes have occurred within a container object.
michael@0 119 */
michael@0 120 const unsigned long EVENT_SELECTION_WITHIN = 0x0012;
michael@0 121
michael@0 122 /**
michael@0 123 * An alert has been generated. Server applications send this event when a
michael@0 124 * user needs to know that a user interface element has changed.
michael@0 125 */
michael@0 126 const unsigned long EVENT_ALERT = 0x0013;
michael@0 127
michael@0 128 /**
michael@0 129 * The foreground window has changed.
michael@0 130 */
michael@0 131 const unsigned long EVENT_FOREGROUND = 0x0014;
michael@0 132
michael@0 133 /**
michael@0 134 * A menu item on the menu bar has been selected.
michael@0 135 */
michael@0 136 const unsigned long EVENT_MENU_START = 0x0015;
michael@0 137
michael@0 138 /**
michael@0 139 * A menu from the menu bar has been closed.
michael@0 140 */
michael@0 141 const unsigned long EVENT_MENU_END = 0x0016;
michael@0 142
michael@0 143 /**
michael@0 144 * A pop-up menu has been displayed.
michael@0 145 */
michael@0 146 const unsigned long EVENT_MENUPOPUP_START = 0x0017;
michael@0 147
michael@0 148 /**
michael@0 149 * A pop-up menu has been closed.
michael@0 150 */
michael@0 151 const unsigned long EVENT_MENUPOPUP_END = 0x0018;
michael@0 152
michael@0 153 /**
michael@0 154 * A window has received mouse capture.
michael@0 155 */
michael@0 156 const unsigned long EVENT_CAPTURE_START = 0x0019;
michael@0 157
michael@0 158 /**
michael@0 159 * A window has lost mouse capture.
michael@0 160 */
michael@0 161 const unsigned long EVENT_CAPTURE_END = 0x001A;
michael@0 162
michael@0 163 /**
michael@0 164 * A window is being moved or resized.
michael@0 165 */
michael@0 166 const unsigned long EVENT_MOVESIZE_START = 0x001B;
michael@0 167
michael@0 168 /**
michael@0 169 * The movement or resizing of a window has finished
michael@0 170 */
michael@0 171 const unsigned long EVENT_MOVESIZE_END = 0x001C;
michael@0 172
michael@0 173 /**
michael@0 174 * A window has entered context-sensitive Help mode
michael@0 175 */
michael@0 176 const unsigned long EVENT_CONTEXTHELP_START = 0x001D;
michael@0 177
michael@0 178 /**
michael@0 179 * A window has exited context-sensitive Help mode
michael@0 180 */
michael@0 181 const unsigned long EVENT_CONTEXTHELP_END = 0x001E;
michael@0 182
michael@0 183 /**
michael@0 184 * An application is about to enter drag-and-drop mode
michael@0 185 */
michael@0 186 const unsigned long EVENT_DRAGDROP_START = 0x001F;
michael@0 187
michael@0 188 /**
michael@0 189 * An application is about to exit drag-and-drop mode
michael@0 190 */
michael@0 191 const unsigned long EVENT_DRAGDROP_END = 0x0020;
michael@0 192
michael@0 193 /**
michael@0 194 * A dialog box has been displayed
michael@0 195 */
michael@0 196 const unsigned long EVENT_DIALOG_START = 0x0021;
michael@0 197
michael@0 198 /**
michael@0 199 * A dialog box has been closed
michael@0 200 */
michael@0 201 const unsigned long EVENT_DIALOG_END = 0x0022;
michael@0 202
michael@0 203 /**
michael@0 204 * Scrolling has started on a scroll bar
michael@0 205 */
michael@0 206 const unsigned long EVENT_SCROLLING_START = 0x0023;
michael@0 207
michael@0 208 /**
michael@0 209 * Scrolling has ended on a scroll bar
michael@0 210 */
michael@0 211 const unsigned long EVENT_SCROLLING_END = 0x0024;
michael@0 212
michael@0 213 /**
michael@0 214 * A window object is about to be minimized or maximized
michael@0 215 */
michael@0 216 const unsigned long EVENT_MINIMIZE_START = 0x0025;
michael@0 217
michael@0 218 /**
michael@0 219 * A window object has been minimized or maximized
michael@0 220 */
michael@0 221 const unsigned long EVENT_MINIMIZE_END = 0x0026;
michael@0 222
michael@0 223 /**
michael@0 224 * The loading of the document has completed.
michael@0 225 */
michael@0 226 const unsigned long EVENT_DOCUMENT_LOAD_COMPLETE = 0x0027;
michael@0 227
michael@0 228 /**
michael@0 229 * The document contents are being reloaded.
michael@0 230 */
michael@0 231 const unsigned long EVENT_DOCUMENT_RELOAD = 0x0028;
michael@0 232
michael@0 233 /**
michael@0 234 * The loading of the document was interrupted.
michael@0 235 */
michael@0 236 const unsigned long EVENT_DOCUMENT_LOAD_STOPPED = 0x0029;
michael@0 237
michael@0 238 /**
michael@0 239 * The document wide attributes of the document object have changed.
michael@0 240 */
michael@0 241 const unsigned long EVENT_DOCUMENT_ATTRIBUTES_CHANGED = 0x002A;
michael@0 242
michael@0 243 /**
michael@0 244 * The contents of the document have changed.
michael@0 245 */
michael@0 246 const unsigned long EVENT_DOCUMENT_CONTENT_CHANGED = 0x002B;
michael@0 247
michael@0 248 const unsigned long EVENT_PROPERTY_CHANGED = 0x002C;
michael@0 249
michael@0 250 /**
michael@0 251 * A slide changed in a presentation document or a page boundary was
michael@0 252 * crossed in a word processing document.
michael@0 253 */
michael@0 254 const unsigned long EVENT_PAGE_CHANGED = 0x002D;
michael@0 255
michael@0 256 /**
michael@0 257 * A text object's attributes changed.
michael@0 258 * Also see EVENT_OBJECT_ATTRIBUTE_CHANGED.
michael@0 259 */
michael@0 260 const unsigned long EVENT_TEXT_ATTRIBUTE_CHANGED = 0x002E;
michael@0 261
michael@0 262 /**
michael@0 263 * The caret has moved to a new position.
michael@0 264 */
michael@0 265 const unsigned long EVENT_TEXT_CARET_MOVED = 0x002F;
michael@0 266
michael@0 267 /**
michael@0 268 * This event indicates general text changes, i.e. changes to text that is
michael@0 269 * exposed through the IAccessibleText and IAccessibleEditableText interfaces.
michael@0 270 */
michael@0 271 const unsigned long EVENT_TEXT_CHANGED = 0x0030;
michael@0 272
michael@0 273 /**
michael@0 274 * Text was inserted.
michael@0 275 */
michael@0 276 const unsigned long EVENT_TEXT_INSERTED = 0x0031;
michael@0 277
michael@0 278 /**
michael@0 279 * Text was removed.
michael@0 280 */
michael@0 281 const unsigned long EVENT_TEXT_REMOVED = 0x0032;
michael@0 282
michael@0 283 /**
michael@0 284 * Text was updated.
michael@0 285 */
michael@0 286 const unsigned long EVENT_TEXT_UPDATED = 0x0033;
michael@0 287
michael@0 288 /**
michael@0 289 * The text selection changed.
michael@0 290 */
michael@0 291 const unsigned long EVENT_TEXT_SELECTION_CHANGED = 0x0034;
michael@0 292
michael@0 293 /**
michael@0 294 * A visibile data event indicates the change of the visual appearance
michael@0 295 * of an accessible object. This includes for example most of the
michael@0 296 * attributes available via the IAccessibleComponent interface.
michael@0 297 */
michael@0 298 const unsigned long EVENT_VISIBLE_DATA_CHANGED = 0x0035;
michael@0 299
michael@0 300 /**
michael@0 301 * The caret moved from one column to the next.
michael@0 302 */
michael@0 303 const unsigned long EVENT_TEXT_COLUMN_CHANGED = 0x0036;
michael@0 304
michael@0 305 /**
michael@0 306 * The caret moved from one section to the next.
michael@0 307 */
michael@0 308 const unsigned long EVENT_SECTION_CHANGED = 0x0037;
michael@0 309
michael@0 310 /**
michael@0 311 * A table caption changed.
michael@0 312 */
michael@0 313 const unsigned long EVENT_TABLE_CAPTION_CHANGED = 0x0038;
michael@0 314
michael@0 315 /**
michael@0 316 * A table's data changed.
michael@0 317 */
michael@0 318 const unsigned long EVENT_TABLE_MODEL_CHANGED = 0x0039;
michael@0 319
michael@0 320 /**
michael@0 321 * A table's summary changed.
michael@0 322 */
michael@0 323 const unsigned long EVENT_TABLE_SUMMARY_CHANGED = 0x003A;
michael@0 324
michael@0 325 /**
michael@0 326 * A table's row description changed.
michael@0 327 */
michael@0 328 const unsigned long EVENT_TABLE_ROW_DESCRIPTION_CHANGED = 0x003B;
michael@0 329
michael@0 330 /**
michael@0 331 * A table's row header changed.
michael@0 332 */
michael@0 333 const unsigned long EVENT_TABLE_ROW_HEADER_CHANGED = 0x003C;
michael@0 334
michael@0 335 const unsigned long EVENT_TABLE_ROW_INSERT = 0x003D;
michael@0 336 const unsigned long EVENT_TABLE_ROW_DELETE = 0x003E;
michael@0 337 const unsigned long EVENT_TABLE_ROW_REORDER = 0x003F;
michael@0 338
michael@0 339 /**
michael@0 340 * A table's column description changed.
michael@0 341 */
michael@0 342 const unsigned long EVENT_TABLE_COLUMN_DESCRIPTION_CHANGED = 0x0040;
michael@0 343
michael@0 344 /**
michael@0 345 * A table's column header changed.
michael@0 346 */
michael@0 347 const unsigned long EVENT_TABLE_COLUMN_HEADER_CHANGED = 0x0041;
michael@0 348
michael@0 349 const unsigned long EVENT_TABLE_COLUMN_INSERT = 0x0042;
michael@0 350 const unsigned long EVENT_TABLE_COLUMN_DELETE = 0x0043;
michael@0 351 const unsigned long EVENT_TABLE_COLUMN_REORDER = 0x0044;
michael@0 352
michael@0 353 const unsigned long EVENT_WINDOW_ACTIVATE = 0x0045;
michael@0 354 const unsigned long EVENT_WINDOW_CREATE = 0x0046;
michael@0 355 const unsigned long EVENT_WINDOW_DEACTIVATE = 0x0047;
michael@0 356 const unsigned long EVENT_WINDOW_DESTROY = 0x0048;
michael@0 357 const unsigned long EVENT_WINDOW_MAXIMIZE = 0x0049;
michael@0 358 const unsigned long EVENT_WINDOW_MINIMIZE = 0x004A;
michael@0 359 const unsigned long EVENT_WINDOW_RESIZE = 0x004B;
michael@0 360 const unsigned long EVENT_WINDOW_RESTORE = 0x004C;
michael@0 361
michael@0 362 /**
michael@0 363 * The ending index of this link within the containing string has changed.
michael@0 364 */
michael@0 365 const unsigned long EVENT_HYPERLINK_END_INDEX_CHANGED = 0x004D;
michael@0 366
michael@0 367 /**
michael@0 368 * The number of anchors assoicated with this hyperlink object has changed.
michael@0 369 */
michael@0 370 const unsigned long EVENT_HYPERLINK_NUMBER_OF_ANCHORS_CHANGED = 0x004E;
michael@0 371
michael@0 372 /**
michael@0 373 * The hyperlink selected state changed from selected to unselected or
michael@0 374 * from unselected to selected.
michael@0 375 */
michael@0 376 const unsigned long EVENT_HYPERLINK_SELECTED_LINK_CHANGED = 0x004F;
michael@0 377
michael@0 378 /**
michael@0 379 * One of the links associated with the hypertext object has been activated.
michael@0 380 */
michael@0 381 const unsigned long EVENT_HYPERTEXT_LINK_ACTIVATED = 0x0050;
michael@0 382
michael@0 383 /**
michael@0 384 * One of the links associated with the hypertext object has been selected.
michael@0 385 */
michael@0 386 const unsigned long EVENT_HYPERTEXT_LINK_SELECTED = 0x0051;
michael@0 387
michael@0 388 /**
michael@0 389 * The starting index of this link within the containing string has changed.
michael@0 390 */
michael@0 391 const unsigned long EVENT_HYPERLINK_START_INDEX_CHANGED = 0x0052;
michael@0 392
michael@0 393 /**
michael@0 394 * Focus has changed from one hypertext object to another, or focus moved
michael@0 395 * from a non-hypertext object to a hypertext object, or focus moved from a
michael@0 396 * hypertext object to a non-hypertext object.
michael@0 397 */
michael@0 398 const unsigned long EVENT_HYPERTEXT_CHANGED = 0x0053;
michael@0 399
michael@0 400 /**
michael@0 401 * The number of hyperlinks associated with a hypertext object changed.
michael@0 402 */
michael@0 403 const unsigned long EVENT_HYPERTEXT_NLINKS_CHANGED = 0x0054;
michael@0 404
michael@0 405 /**
michael@0 406 * An object's attributes changed. Also see EVENT_TEXT_ATTRIBUTE_CHANGED.
michael@0 407 */
michael@0 408 const unsigned long EVENT_OBJECT_ATTRIBUTE_CHANGED = 0x0055;
michael@0 409
michael@0 410 /**
michael@0 411 * A cursorable's virtual cursor has changed.
michael@0 412 */
michael@0 413 const unsigned long EVENT_VIRTUALCURSOR_CHANGED = 0x0056;
michael@0 414
michael@0 415 /**
michael@0 416 * Help make sure event map does not get out-of-line.
michael@0 417 */
michael@0 418 const unsigned long EVENT_LAST_ENTRY = 0x0057;
michael@0 419
michael@0 420 /**
michael@0 421 * The type of event, based on the enumerated event values
michael@0 422 * defined in this interface.
michael@0 423 */
michael@0 424 readonly attribute unsigned long eventType;
michael@0 425
michael@0 426 /**
michael@0 427 * The nsIAccessible associated with the event.
michael@0 428 * May return null if no accessible is available
michael@0 429 */
michael@0 430 readonly attribute nsIAccessible accessible;
michael@0 431
michael@0 432 /**
michael@0 433 * The nsIAccessibleDocument that the event target nsIAccessible
michael@0 434 * resides in. This can be used to get the DOM window,
michael@0 435 * the DOM document and the window handler, among other things.
michael@0 436 */
michael@0 437 readonly attribute nsIAccessibleDocument accessibleDocument;
michael@0 438
michael@0 439 /**
michael@0 440 * The nsIDOMNode associated with the event
michael@0 441 * May return null if accessible for event has been shut down
michael@0 442 */
michael@0 443 readonly attribute nsIDOMNode DOMNode;
michael@0 444
michael@0 445 /**
michael@0 446 * Returns true if the event was caused by explicit user input,
michael@0 447 * as opposed to purely originating from a timer or mouse movement
michael@0 448 */
michael@0 449 readonly attribute boolean isFromUserInput;
michael@0 450 };

mercurial