Visit Mozilla.org

nsIAccessibleEvent

From MDC


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);

Contents

nsIAccessibleEvent is defined in accessible/public/nsIAccessibleEvent.idl. It is scriptable and is currently under review.

Inherits from: nsISupports


[edit] Attributes

Attribute Type Description
eventType unsigned long The type of event, based on the enumerated event values defined in this interface.
accessible nsIAccessible The nsIAccessible associated with the event. May return null if no accessible is available
accessibleDocument nsIAccessibleDocument 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.
DOMNode nsIDOMNode The nsIDOMNode associated with the event. May return null if accessible for event has been shut down.
isFromUserInput boolean Returns true if the event was caused by explicit user input, as opposed to purely originating from a timer or mouse movement.

[edit] Constants

Constant Value Description
EVENT_DOM_CREATE 0x0001 unsigned long data type. An object has been created.
EVENT_DOM_DESTROY 0x0002 unsigned long data type. An object has been destroyed.
EVENT_DOM_SIGNIFICANT_CHANGE 0x0003 unsigned long data type. An object's properties or content have changed significantly so that the type of object has really changed, and therefore the accessible should be destroyed or recreated.
EVENT_ASYNCH_SHOW 0x0004 unsigned long data type. A hidden object is shown -- this is a layout occurance and is thus asynchronous
EVENT_ASYNCH_HIDE 0x0005 unsigned long data type. An object is hidden -- this is a layout occurance and is thus asynchronous
EVENT_ASYNCH_SIGNIFICANT_CHANGE 0x0006 unsigned long data type. An object had a significant layout change which could affect the type of accessible object -- this is a layout occurance and is thus asynchronous
EVENT_ACTIVE_DECENDENT_CHANGED 0x0007 unsigned long data type. The active descendant of a component has changed. The active descendant is used in objects with transient children.
EVENT_FOCUS 0x0008 unsigned long data type. An object has received the keyboard focus.
EVENT_STATE_CHANGE 0x0009 unsigned long data type. An object's state has changed.
EVENT_LOCATION_CHANGE 0x000A unsigned long data type. An object has changed location, shape, or size.
EVENT_NAME_CHANGE 0x000B unsigned long data type. An object's Name property has changed.
EVENT_DESCRIPTION_CHANGE 0x000C unsigned long data type. An object's Description property has changed.
EVENT_VALUE_CHANGE 0x000D unsigned long data type. An object's Value property has changed.
EVENT_HELP_CHANGE 0x000E unsigned long data type. An object's help has changed.
EVENT_DEFACTION_CHANGE 0x000F unsigned long data type. An object's default action has changed.
EVENT_ACTION_CHANGE 0x0010 unsigned long data type. An object's action has changed.
EVENT_ACCELERATOR_CHANGE 0x0011 unsigned long data type. An object's keyboard shortcut has changed.
EVENT_SELECTION 0x0012 unsigned long data type. The selection within a container object has changed.
EVENT_SELECTION_ADD 0x0013 unsigned long data type. An item within a container object has been added to the selection.
EVENT_SELECTION_REMOVE 0x0014 unsigned long data type. An item within a container object has been removed from the selection.
EVENT_SELECTION_WITHIN 0x0015 unsigned long data type. Numerous selection changes have occurred within a container object.
EVENT_ALERT 0x0016 unsigned long data type. An alert has been generated. Server applications send this event when a user needs to know that a user interface element has changed.
EVENT_FOREGROUND 0x0017 unsigned long data type. The foreground window has changed.
EVENT_MENU_START 0x0018 unsigned long data type. A menu item on the menu bar has been selected.
EVENT_MENU_START 0x0019 unsigned long data type. A menu from the menu bar has been closed.
EVENT_MENUPOPUP_START 0x001A unsigned long data type. A pop-up menu has been displayed.
EVENT_MENUPOPUP_END 0x001B unsigned long data type. A pop-up menu has been closed.
EVENT_CAPTURE_START 0x001C unsigned long data type. A window has received mouse capture.
EVENT_CAPTURE_END 0x001D unsigned long data type. A window has lost mouse capture.
EVENT_MOVESIZE_START 0x001E unsigned long data type. A window is being moved or resized.
EVENT_MOVESIZE_END 0x001F unsigned long data type. The movement or resizing of a window has finished
EVENT_CONTEXTHELP_START 0x0020 unsigned long data type. A window has entered context-sensitive Help mode
EVENT_CONTEXTHELP_END 0x0021 unsigned long data type. A window has exited context-sensitive Help mode
EVENT_DRAGDROP_START 0x0022 unsigned long data type. An application is about to enter drag-and-drop mode
EVENT_DRAGDROP_END 0x0023 unsigned long data type. An application is about to exit drag-and-drop mode
EVENT_DIALOG_START 0x0024 unsigned long data type. A dialog box has been displayed
EVENT_DIALOG_END 0x0025 unsigned long data type. A dialog box has been closed
EVENT_SCROLLING_START 0x0026 unsigned long data type. Scrolling has started on a scroll bar
EVENT_SCROLLING_END 0x0027 unsigned long data type. Scrolling has ended on a scroll bar
EVENT_MINIMIZE_START 0x0028 unsigned long data type. A window object is about to be minimized or maximized
EVENT_MINIMIZE_END 0x0029 unsigned long data type. A window object has been minimized or maximized
EVENT_DOCUMENT_LOAD_START 0x002A unsigned long data type.
EVENT_DOCUMENT_LOAD_COMPLETE 0x002B unsigned long data type. The loading of the document has completed.
EVENT_DOCUMENT_RELOAD 0x002C unsigned long data type. The document contents are being reloaded.
EVENT_DOCUMENT_LOAD_STOPPED 0x002D unsigned long data type. The loading of the document was interrupted.
EVENT_DOCUMENT_ATTRIBUTES_CHANGED 0x002E unsigned long data type. The document wide attributes of the document object have changed.
EVENT_DOCUMENT_CONTENT_CHANGED 0x002F unsigned long data type. The contents of the document have changed.
EVENT_PROPERTY_CHANGED 0x0030 unsigned long data type.
EVENT_SELECTION_CHANGED 0x0031 unsigned long data type.
EVENT_TEXT_ATTRIBUTE_CHANGED 0x0032 unsigned long data type. A text object's attributes changed. Also see EVENT_OBJECT_ATTRIBUTE_CHANGED.
EVENT_TEXT_CARET_MOVED 0x0033 unsigned long data type. The caret has moved to a new position.
EVENT_TEXT_CHANGED 0x0034 unsigned long data type. This event indicates general text changes, i.e. changes to text that is exposed through the IAccessibleText and IAccessibleEditableText interfaces.
EVENT_TEXT_INSERTED 0x0035 unsigned long data type. Text was inserted.
EVENT_TEXT_REMOVED 0x0036 unsigned long data type. Text was removed.
EVENT_TEXT_UPDATED 0x0037 unsigned long data type. Text was updated.
EVENT_TEXT_SELECTION_CHANGED 0x0038 unsigned long data type. Text was changed.
EVENT_VISIBLE_DATA_CHANGED 0x0039 unsigned long data type. 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.
EVENT_TEXT_COLUMN_CHANGED 0x003A unsigned long data type. The caret moved from one column to the next.
EVENT_SECTION_CHANGED 0x003B unsigned long data type. The caret moved from one section to the next.
EVENT_TABLE_CAPTION_CHANGED 0x003C unsigned long data type. A table caption changed.
EVENT_TABLE_MODEL_CHANGED 0x003D unsigned long data type. A table's data changed.
EVENT_TABLE_SUMMARY_CHANGED 0x003E unsigned long data type. A table's summary changed.
EVENT_TABLE_ROW_DESCRIPTION_CHANGED 0x003F unsigned long data type. A table's row description changed.
EVENT_TABLE_ROW_HEADER_CHANGED 0x0040 unsigned long data type. A table's row header changed.
EVENT_TABLE_ROW_INSERT 0x0041 unsigned long data type.
EVENT_TABLE_ROW_DELETE 0x0042 unsigned long data type.
EVENT_TABLE_ROW_REORDER 0x0043 unsigned long data type.
EVENT_TABLE_COLUMN_DESCRIPTION_CHANGED 0x0044 unsigned long data type. A table's column description changed.
EVENT_TABLE_COLUMN_HEADER_CHANGED 0x0045 unsigned long data type. A table's column header changed.
EVENT_TABLE_COLUMN_INSERT 0x0046 unsigned long data type.
EVENT_TABLE_COLUMN_DELETE 0x0047 unsigned long data type.
EVENT_TABLE_COLUMN_REORDER 0x0048 unsigned long data type.
EVENT_WINDOW_ACTIVATE 0x0049 unsigned long data type.
EVENT_WINDOW_CREATE 0x004A unsigned long data type.
EVENT_WINDOW_DEACTIVATE 0x004B unsigned long data type.
EVENT_WINDOW_DESTROY 0x004C unsigned long data type.
EVENT_WINDOW_MAXIMIZE 0x004D unsigned long data type.
EVENT_WINDOW_MINIMIZE 0x004E unsigned long data type.
EVENT_WINDOW_RESIZE 0x004F unsigned long data type.
EVENT_WINDOW_RESTORE 0x0050 unsigned long data type.
EVENT_HYPERLINK_END_INDEX_CHANGED 0x0051 unsigned long data type. The ending index of this link within the containing string has changed.
EVENT_HYPERLINK_NUMBER_OF_ANCHORS_CHANGED 0x0052 unsigned long data type. The number of anchors assoicated with this hyperlink object has changed.
EVENT_HYPERLINK_SELECTED_LINK_CHANGED 0x0053 unsigned long data type. The hyperlink selected state changed from selected to unselected or from unselected to selected.
EVENT_HYPERTEXT_LINK_ACTIVATED 0x0054 unsigned long data type. One of the links associated with the hypertext object has been activated.
EVENT_HYPERTEXT_LINK_SELECTED 0x0055 unsigned long data type. One of the links associated with the hypertext object has been selected.
EVENT_HYPERLINK_START_INDEX_CHANGED 0x0056 unsigned long data type. The starting index of this link within the containing string has changed.
EVENT_HYPERTEXT_CHANGED 0x0057 unsigned long data type. 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.
EVENT_HYPERTEXT_NLINKS_CHANGED 0x0058 unsigned long data type. The number of hyperlinks associated with a hypertext object changed.
EVENT_OBJECT_ATTRIBUTE_CHANGED 0x0059 unsigned long data type. An object's attributes changed. Also see EVENT_TEXT_ATTRIBUTE_CHANGED.
EVENT_PAGE_CHANGED 0x005A unsigned long data type. A slide changed in a presentation document or a page boundary was crossed in a word processing document.
EVENT_INTERNAL_LOAD 0x005B unsigned long data type. Used internally in Gecko.
EVENT_REORDER 0x005C unsigned long data type. An object's children have changed
EVENT_LAST_ENTRY 0x005D unsigned long data type. Help make sure event map does not get out-of-line.