Public Attributes

nsIAccessibleEvent Interface Reference

An interface for accessibility events listened to by in-process accessibility clients, which can be used to find out how to get accessibility and DOM interfaces for the event and its target. More...

import "nsIAccessibleEvent.idl";

Inheritance diagram for nsIAccessibleEvent:
Collaboration diagram for nsIAccessibleEvent:

List of all members.

Public Attributes

const unsigned long EVENT_SHOW = 0x0001
 An object has been created.
const unsigned long EVENT_HIDE = 0x0002
 An object has been destroyed.
const unsigned long EVENT_REORDER = 0x0003
 An object's children have changed.
const unsigned long EVENT_ACTIVE_DECENDENT_CHANGED = 0x0004
 The active descendant of a component has changed.
const unsigned long EVENT_FOCUS = 0x0005
 An object has received the keyboard focus.
const unsigned long EVENT_STATE_CHANGE = 0x0006
 An object's state has changed.
const unsigned long EVENT_LOCATION_CHANGE = 0x0007
 An object has changed location, shape, or size.
const unsigned long EVENT_NAME_CHANGE = 0x0008
 An object's Name property has changed.
const unsigned long EVENT_DESCRIPTION_CHANGE = 0x0009
 An object's Description property has changed.
const unsigned long EVENT_VALUE_CHANGE = 0x000A
 An object's Value property has changed.
const unsigned long EVENT_HELP_CHANGE = 0x000B
 An object's help has changed.
const unsigned long EVENT_DEFACTION_CHANGE = 0x000C
 An object's default action has changed.
const unsigned long EVENT_ACTION_CHANGE = 0x000D
 An object's action has changed.
const unsigned long EVENT_ACCELERATOR_CHANGE = 0x000E
 An object's keyboard shortcut has changed.
const unsigned long EVENT_SELECTION = 0x000F
 The selection within a container object has changed.
const unsigned long EVENT_SELECTION_ADD = 0x0010
 An item within a container object has been added to the selection.
const unsigned long EVENT_SELECTION_REMOVE = 0x0011
 An item within a container object has been removed from the selection.
const unsigned long EVENT_SELECTION_WITHIN = 0x0012
 Numerous selection changes have occurred within a container object.
const unsigned long EVENT_ALERT = 0x0013
 An alert has been generated.
const unsigned long EVENT_FOREGROUND = 0x0014
 The foreground window has changed.
const unsigned long EVENT_MENU_START = 0x0015
 A menu item on the menu bar has been selected.
const unsigned long EVENT_MENU_END = 0x0016
 A menu from the menu bar has been closed.
const unsigned long EVENT_MENUPOPUP_START = 0x0017
 A pop-up menu has been displayed.
const unsigned long EVENT_MENUPOPUP_END = 0x0018
 A pop-up menu has been closed.
const unsigned long EVENT_CAPTURE_START = 0x0019
 A window has received mouse capture.
const unsigned long EVENT_CAPTURE_END = 0x001A
 A window has lost mouse capture.
const unsigned long EVENT_MOVESIZE_START = 0x001B
 A window is being moved or resized.
const unsigned long EVENT_MOVESIZE_END = 0x001C
 The movement or resizing of a window has finished.
const unsigned long EVENT_CONTEXTHELP_START = 0x001D
 A window has entered context-sensitive Help mode.
const unsigned long EVENT_CONTEXTHELP_END = 0x001E
 A window has exited context-sensitive Help mode.
const unsigned long EVENT_DRAGDROP_START = 0x001F
 An application is about to enter drag-and-drop mode.
const unsigned long EVENT_DRAGDROP_END = 0x0020
 An application is about to exit drag-and-drop mode.
const unsigned long EVENT_DIALOG_START = 0x0021
 A dialog box has been displayed.
const unsigned long EVENT_DIALOG_END = 0x0022
 A dialog box has been closed.
const unsigned long EVENT_SCROLLING_START = 0x0023
 Scrolling has started on a scroll bar.
const unsigned long EVENT_SCROLLING_END = 0x0024
 Scrolling has ended on a scroll bar.
const unsigned long EVENT_MINIMIZE_START = 0x0025
 A window object is about to be minimized or maximized.
const unsigned long EVENT_MINIMIZE_END = 0x0026
 A window object has been minimized or maximized.
const unsigned long EVENT_DOCUMENT_LOAD_START = 0x0027
 XXX:
const unsigned long EVENT_DOCUMENT_LOAD_COMPLETE = 0x0028
 The loading of the document has completed.
const unsigned long EVENT_DOCUMENT_RELOAD = 0x0029
 The document contents are being reloaded.
const unsigned long EVENT_DOCUMENT_LOAD_STOPPED = 0x002A
 The loading of the document was interrupted.
const unsigned long EVENT_DOCUMENT_ATTRIBUTES_CHANGED = 0x002B
 The document wide attributes of the document object have changed.
const unsigned long EVENT_DOCUMENT_CONTENT_CHANGED = 0x002C
 The contents of the document have changed.
const unsigned long EVENT_PROPERTY_CHANGED = 0x002D
const unsigned long EVENT_SELECTION_CHANGED = 0x002E
const unsigned long EVENT_TEXT_ATTRIBUTE_CHANGED = 0x002F
 A text object's attributes changed.
const unsigned long EVENT_TEXT_CARET_MOVED = 0x0030
 The caret has moved to a new position.
const unsigned long EVENT_TEXT_CHANGED = 0x0031
 This event indicates general text changes, i.e.
const unsigned long EVENT_TEXT_INSERTED = 0x0032
 Text was inserted.
const unsigned long EVENT_TEXT_REMOVED = 0x0033
 Text was removed.
const unsigned long EVENT_TEXT_UPDATED = 0x0034
 Text was updated.
const unsigned long EVENT_TEXT_SELECTION_CHANGED = 0x0035
 The text selection changed.
const unsigned long EVENT_VISIBLE_DATA_CHANGED = 0x0036
 A visibile data event indicates the change of the visual appearance of an accessible object.
const unsigned long EVENT_TEXT_COLUMN_CHANGED = 0x0037
 The caret moved from one column to the next.
const unsigned long EVENT_SECTION_CHANGED = 0x0038
 The caret moved from one section to the next.
const unsigned long EVENT_TABLE_CAPTION_CHANGED = 0x0039
 A table caption changed.
const unsigned long EVENT_TABLE_MODEL_CHANGED = 0x003A
 A table's data changed.
const unsigned long EVENT_TABLE_SUMMARY_CHANGED = 0x003B
 A table's summary changed.
const unsigned long EVENT_TABLE_ROW_DESCRIPTION_CHANGED = 0x003C
 A table's row description changed.
const unsigned long EVENT_TABLE_ROW_HEADER_CHANGED = 0x003D
 A table's row header changed.
const unsigned long EVENT_TABLE_ROW_INSERT = 0x003E
const unsigned long EVENT_TABLE_ROW_DELETE = 0x003F
const unsigned long EVENT_TABLE_ROW_REORDER = 0x0040
const unsigned long EVENT_TABLE_COLUMN_DESCRIPTION_CHANGED = 0x0041
 A table's column description changed.
const unsigned long EVENT_TABLE_COLUMN_HEADER_CHANGED = 0x0042
 A table's column header changed.
const unsigned long EVENT_TABLE_COLUMN_INSERT = 0x0043
const unsigned long EVENT_TABLE_COLUMN_DELETE = 0x0044
const unsigned long EVENT_TABLE_COLUMN_REORDER = 0x0045
const unsigned long EVENT_WINDOW_ACTIVATE = 0x0046
const unsigned long EVENT_WINDOW_CREATE = 0x0047
const unsigned long EVENT_WINDOW_DEACTIVATE = 0x0048
const unsigned long EVENT_WINDOW_DESTROY = 0x0049
const unsigned long EVENT_WINDOW_MAXIMIZE = 0x004A
const unsigned long EVENT_WINDOW_MINIMIZE = 0x004B
const unsigned long EVENT_WINDOW_RESIZE = 0x004C
const unsigned long EVENT_WINDOW_RESTORE = 0x004D
const unsigned long EVENT_HYPERLINK_END_INDEX_CHANGED = 0x004E
 The ending index of this link within the containing string has changed.
const unsigned long EVENT_HYPERLINK_NUMBER_OF_ANCHORS_CHANGED = 0x004F
 The number of anchors assoicated with this hyperlink object has changed.
const unsigned long EVENT_HYPERLINK_SELECTED_LINK_CHANGED = 0x0050
 The hyperlink selected state changed from selected to unselected or from unselected to selected.
const unsigned long EVENT_HYPERTEXT_LINK_ACTIVATED = 0x0051
 One of the links associated with the hypertext object has been activated.
const unsigned long EVENT_HYPERTEXT_LINK_SELECTED = 0x0052
 One of the links associated with the hypertext object has been selected.
const unsigned long EVENT_HYPERLINK_START_INDEX_CHANGED = 0x0053
 The starting index of this link within the containing string has changed.
const unsigned long EVENT_HYPERTEXT_CHANGED = 0x0054
 Focus has changed from one hypertext object to another, or focus moved from a non-hypertext object to a hypertext object, or focus moved from a hypertext object to a non-hypertext object.
const unsigned long EVENT_HYPERTEXT_NLINKS_CHANGED = 0x0055
 The number of hyperlinks associated with a hypertext object changed.
const unsigned long EVENT_OBJECT_ATTRIBUTE_CHANGED = 0x0056
 An object's attributes changed.
const unsigned long EVENT_PAGE_CHANGED = 0x0057
 A slide changed in a presentation document or a page boundary was crossed in a word processing document.
const unsigned long EVENT_INTERNAL_LOAD = 0x0058
 Used internally in Gecko.
const unsigned long EVENT_LAST_ENTRY = 0x0059
 Help make sure event map does not get out-of-line.
readonly attribute unsigned long eventType
 The type of event, based on the enumerated event values defined in this interface.
readonly attribute nsIAccessible accessible
 The nsIAccessible associated with the event.
readonly attribute
nsIAccessibleDocument 
accessibleDocument
 The nsIAccessibleDocument that the event target nsIAccessible resides in.
readonly attribute nsIDOMNode DOMNode
 The nsIDOMNode associated with the event May return null if accessible for event has been shut down.
attribute boolean isFromUserInput
 Returns true if the event was caused by explicit user input, as opposed to purely originating from a timer or mouse movement.

Detailed Description

An interface for accessibility events listened to by in-process accessibility clients, which can be used to find out how to get accessibility and DOM interfaces for the event and its target.

To listen to in-process accessibility invents, make your object an nsIObserver, and listen for accessible-event by using code something like this: nsCOMPtr<nsIObserverService> observerService = do_GetService("@mozilla.org/observer-service;1", &rv); if (NS_SUCCEEDED(rv)) rv = observerService->AddObserver(this, "accessible-event", PR_TRUE);

Status:
UNDER_REVIEW

Member Data Documentation

The nsIAccessible associated with the event.

May return null if no accessible is available

The nsIAccessibleDocument that the event target nsIAccessible resides in.

This can be used to get the DOM window, the DOM document and the window handler, among other things.

The nsIDOMNode associated with the event May return null if accessible for event has been shut down.

const unsigned long nsIAccessibleEvent::EVENT_ACCELERATOR_CHANGE = 0x000E

An object's keyboard shortcut has changed.

const unsigned long nsIAccessibleEvent::EVENT_ACTION_CHANGE = 0x000D

An object's action has changed.

The active descendant of a component has changed.

The active descendant is used in objects with transient children.

const unsigned long nsIAccessibleEvent::EVENT_ALERT = 0x0013

An alert has been generated.

Server applications send this event when a user needs to know that a user interface element has changed.

const unsigned long nsIAccessibleEvent::EVENT_CAPTURE_END = 0x001A

A window has lost mouse capture.

const unsigned long nsIAccessibleEvent::EVENT_CAPTURE_START = 0x0019

A window has received mouse capture.

const unsigned long nsIAccessibleEvent::EVENT_CONTEXTHELP_END = 0x001E

A window has exited context-sensitive Help mode.

const unsigned long nsIAccessibleEvent::EVENT_CONTEXTHELP_START = 0x001D

A window has entered context-sensitive Help mode.

const unsigned long nsIAccessibleEvent::EVENT_DEFACTION_CHANGE = 0x000C

An object's default action has changed.

const unsigned long nsIAccessibleEvent::EVENT_DESCRIPTION_CHANGE = 0x0009

An object's Description property has changed.

const unsigned long nsIAccessibleEvent::EVENT_DIALOG_END = 0x0022

A dialog box has been closed.

const unsigned long nsIAccessibleEvent::EVENT_DIALOG_START = 0x0021

A dialog box has been displayed.

The document wide attributes of the document object have changed.

The contents of the document have changed.

The loading of the document has completed.

const unsigned long nsIAccessibleEvent::EVENT_DOCUMENT_LOAD_START = 0x0027

XXX:

The loading of the document was interrupted.

const unsigned long nsIAccessibleEvent::EVENT_DOCUMENT_RELOAD = 0x0029

The document contents are being reloaded.

const unsigned long nsIAccessibleEvent::EVENT_DRAGDROP_END = 0x0020

An application is about to exit drag-and-drop mode.

const unsigned long nsIAccessibleEvent::EVENT_DRAGDROP_START = 0x001F

An application is about to enter drag-and-drop mode.

const unsigned long nsIAccessibleEvent::EVENT_FOCUS = 0x0005

An object has received the keyboard focus.

const unsigned long nsIAccessibleEvent::EVENT_FOREGROUND = 0x0014

The foreground window has changed.

const unsigned long nsIAccessibleEvent::EVENT_HELP_CHANGE = 0x000B

An object's help has changed.

const unsigned long nsIAccessibleEvent::EVENT_HIDE = 0x0002

An object has been destroyed.

The ending index of this link within the containing string has changed.

The number of anchors assoicated with this hyperlink object has changed.

The hyperlink selected state changed from selected to unselected or from unselected to selected.

The starting index of this link within the containing string has changed.

const unsigned long nsIAccessibleEvent::EVENT_HYPERTEXT_CHANGED = 0x0054

Focus has changed from one hypertext object to another, or focus moved from a non-hypertext object to a hypertext object, or focus moved from a hypertext object to a non-hypertext object.

One of the links associated with the hypertext object has been activated.

One of the links associated with the hypertext object has been selected.

The number of hyperlinks associated with a hypertext object changed.

const unsigned long nsIAccessibleEvent::EVENT_INTERNAL_LOAD = 0x0058

Used internally in Gecko.

const unsigned long nsIAccessibleEvent::EVENT_LAST_ENTRY = 0x0059

Help make sure event map does not get out-of-line.

const unsigned long nsIAccessibleEvent::EVENT_LOCATION_CHANGE = 0x0007

An object has changed location, shape, or size.

const unsigned long nsIAccessibleEvent::EVENT_MENU_END = 0x0016

A menu from the menu bar has been closed.

const unsigned long nsIAccessibleEvent::EVENT_MENU_START = 0x0015

A menu item on the menu bar has been selected.

const unsigned long nsIAccessibleEvent::EVENT_MENUPOPUP_END = 0x0018

A pop-up menu has been closed.

const unsigned long nsIAccessibleEvent::EVENT_MENUPOPUP_START = 0x0017

A pop-up menu has been displayed.

const unsigned long nsIAccessibleEvent::EVENT_MINIMIZE_END = 0x0026

A window object has been minimized or maximized.

const unsigned long nsIAccessibleEvent::EVENT_MINIMIZE_START = 0x0025

A window object is about to be minimized or maximized.

const unsigned long nsIAccessibleEvent::EVENT_MOVESIZE_END = 0x001C

The movement or resizing of a window has finished.

const unsigned long nsIAccessibleEvent::EVENT_MOVESIZE_START = 0x001B

A window is being moved or resized.

const unsigned long nsIAccessibleEvent::EVENT_NAME_CHANGE = 0x0008

An object's Name property has changed.

An object's attributes changed.

Also see EVENT_TEXT_ATTRIBUTE_CHANGED.

const unsigned long nsIAccessibleEvent::EVENT_PAGE_CHANGED = 0x0057

A slide changed in a presentation document or a page boundary was crossed in a word processing document.

const unsigned long nsIAccessibleEvent::EVENT_PROPERTY_CHANGED = 0x002D
const unsigned long nsIAccessibleEvent::EVENT_REORDER = 0x0003

An object's children have changed.

const unsigned long nsIAccessibleEvent::EVENT_SCROLLING_END = 0x0024

Scrolling has ended on a scroll bar.

const unsigned long nsIAccessibleEvent::EVENT_SCROLLING_START = 0x0023

Scrolling has started on a scroll bar.

const unsigned long nsIAccessibleEvent::EVENT_SECTION_CHANGED = 0x0038

The caret moved from one section to the next.

const unsigned long nsIAccessibleEvent::EVENT_SELECTION = 0x000F

The selection within a container object has changed.

const unsigned long nsIAccessibleEvent::EVENT_SELECTION_ADD = 0x0010

An item within a container object has been added to the selection.

const unsigned long nsIAccessibleEvent::EVENT_SELECTION_CHANGED = 0x002E
const unsigned long nsIAccessibleEvent::EVENT_SELECTION_REMOVE = 0x0011

An item within a container object has been removed from the selection.

const unsigned long nsIAccessibleEvent::EVENT_SELECTION_WITHIN = 0x0012

Numerous selection changes have occurred within a container object.

const unsigned long nsIAccessibleEvent::EVENT_SHOW = 0x0001

An object has been created.

const unsigned long nsIAccessibleEvent::EVENT_STATE_CHANGE = 0x0006

An object's state has changed.

A table caption changed.

const unsigned long nsIAccessibleEvent::EVENT_TABLE_COLUMN_DELETE = 0x0044

A table's column description changed.

A table's column header changed.

const unsigned long nsIAccessibleEvent::EVENT_TABLE_COLUMN_INSERT = 0x0043
const unsigned long nsIAccessibleEvent::EVENT_TABLE_COLUMN_REORDER = 0x0045
const unsigned long nsIAccessibleEvent::EVENT_TABLE_MODEL_CHANGED = 0x003A

A table's data changed.

const unsigned long nsIAccessibleEvent::EVENT_TABLE_ROW_DELETE = 0x003F

A table's row description changed.

A table's row header changed.

const unsigned long nsIAccessibleEvent::EVENT_TABLE_ROW_INSERT = 0x003E
const unsigned long nsIAccessibleEvent::EVENT_TABLE_ROW_REORDER = 0x0040

A table's summary changed.

A text object's attributes changed.

Also see EVENT_OBJECT_ATTRIBUTE_CHANGED.

const unsigned long nsIAccessibleEvent::EVENT_TEXT_CARET_MOVED = 0x0030

The caret has moved to a new position.

const unsigned long nsIAccessibleEvent::EVENT_TEXT_CHANGED = 0x0031

This event indicates general text changes, i.e.

changes to text that is exposed through the IAccessibleText and IAccessibleEditableText interfaces.

const unsigned long nsIAccessibleEvent::EVENT_TEXT_COLUMN_CHANGED = 0x0037

The caret moved from one column to the next.

const unsigned long nsIAccessibleEvent::EVENT_TEXT_INSERTED = 0x0032

Text was inserted.

const unsigned long nsIAccessibleEvent::EVENT_TEXT_REMOVED = 0x0033

Text was removed.

The text selection changed.

const unsigned long nsIAccessibleEvent::EVENT_TEXT_UPDATED = 0x0034

Text was updated.

const unsigned long nsIAccessibleEvent::EVENT_VALUE_CHANGE = 0x000A

An object's Value property has changed.

const unsigned long nsIAccessibleEvent::EVENT_VISIBLE_DATA_CHANGED = 0x0036

A visibile data event indicates the change of the visual appearance of an accessible object.

This includes for example most of the attributes available via the IAccessibleComponent interface.

const unsigned long nsIAccessibleEvent::EVENT_WINDOW_ACTIVATE = 0x0046
const unsigned long nsIAccessibleEvent::EVENT_WINDOW_CREATE = 0x0047
const unsigned long nsIAccessibleEvent::EVENT_WINDOW_DEACTIVATE = 0x0048
const unsigned long nsIAccessibleEvent::EVENT_WINDOW_DESTROY = 0x0049
const unsigned long nsIAccessibleEvent::EVENT_WINDOW_MAXIMIZE = 0x004A
const unsigned long nsIAccessibleEvent::EVENT_WINDOW_MINIMIZE = 0x004B
const unsigned long nsIAccessibleEvent::EVENT_WINDOW_RESIZE = 0x004C
const unsigned long nsIAccessibleEvent::EVENT_WINDOW_RESTORE = 0x004D
readonly attribute unsigned long nsIAccessibleEvent::eventType

The type of event, based on the enumerated event values defined in this interface.

Returns true if the event was caused by explicit user input, as opposed to purely originating from a timer or mouse movement.


The documentation for this interface was generated from the following file: