nsIAccessibleRetrieval

IID:663CA4A8-D219-4000-925D-D8F66406B626
Inherits From:nsISupports
Status:UNDER_REVIEW

An interface for in-process accessibility clients wishing to get an nsIAccessible or nsIAccessNode for a given DOM node. More documentation at: http://www.mozilla.org/projects/ui/accessibility

This interface is implemented by the following components:


Methods

nsIAccessible getAccessibleFor ( nsIDOMNode node ) nsIAccessible getAccessibleInShell ( nsIDOMNode node , nsIPresShell presShell ) nsIAccessible getAccessibleInWeakShell ( nsIDOMNode node , nsIWeakReference presShell ) nsIAccessible getAccessibleInWindow ( nsIDOMNode node , nsIDOMWindow DOMWin ) nsIAccessible getCachedAccessible ( nsIDOMNode node , nsIWeakReference shell ) nsIAccessNode getCachedAccessNode ( nsIDOMNode node , nsIWeakReference shell )

nsIAccessible getAccessibleFor ( nsIDOMNode node )

Return an nsIAccessible for a DOM node in pres shell 0. Create a new accessible of the appropriate type if necessary, or use one from the accessibility cache if it already exists.

Arguments:
node: The DOM node to get an accessible for.
Returns:
nsIAccessible for the given DOM node.

nsIAccessible getAccessibleInShell ( nsIDOMNode node , nsIPresShell presShell )

Return an nsIAccessible for a DOM node in the given pres shell. Create a new accessible of the appropriate type if necessary, or use one from the accessibility cache if it already exists.

Arguments:
node: The DOM node to get an accessible for.
presShell: The presentation shell which contains layout info for the DOM node.
Returns:
nsIAccessible for the given DOM node.

nsIAccessible getAccessibleInWeakShell ( nsIDOMNode node , nsIWeakReference presShell )

Return an nsIAccessible for a DOM node in the given weak shell. Create a new accessible of the appropriate type if necessary, or use one from the accessibility cache if it already exists.

Arguments:
node: The DOM node to get an accessible for.
presShell: The presentation shell which contains layout info for the DOM node.
Returns:
nsIAccessible for the given DOM node.

nsIAccessible getAccessibleInWindow ( nsIDOMNode node , nsIDOMWindow DOMWin )

Return an nsIAccessible for a DOM node in pres shell for this DOM window. Create a new accessible of the appropriate type if necessary, or use one from the accessibility cache if it already exists.

Arguments:
node: The DOM node to get an accessible for.
DOMWin: The DOM window containing the node.
Returns:
nsIAccessible for the given DOM node.

nsIAccessible getCachedAccessible ( nsIDOMNode node , nsIWeakReference shell )

Return an nsIAccessible for an already created DOM node in the given weak shell. Does not create a new one -- only returns cached accessibles.

Arguments:
node: The DOM node to get an accessible for.
shell
Returns:
nsIAccessible for the given DOM node or null if an accessible does not already exist for this DOM node.

nsIAccessNode getCachedAccessNode ( nsIDOMNode node , nsIWeakReference shell )

Return an nsIAccessNode for an already created DOM node in the given weak shell. Does not create a new one -- only returns cached access nodes.

Arguments:
node: The DOM node to get an access node for.
shell
Returns:
nsIAccessNode for the given DOM node or null if an access node does not already exist for this DOM node.

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com