Public Member Functions

nsIAccessibleRetrieval Interface Reference

An interface for in-process accessibility clients wishing to get an nsIAccessible or nsIAccessNode for a given DOM node. More...

import "nsIAccessibleRetrieval.idl";

Inheritance diagram for nsIAccessibleRetrieval:

List of all members.

Public Member Functions

nsIAccessible getAccessibleFor (in nsIDOMNode aNode)
 Return an nsIAccessible for a DOM node in pres shell 0.
nsIAccessible getAttachedAccessibleFor (in nsIDOMNode aNode)
 The same like getAccessibleFor method except it returns accessible only if it is attached, i.e.
nsIDOMNode getRelevantContentNodeFor (in nsIDOMNode aNode)
 Return an DOM node that is relevant to attached accesible check.
nsIAccessible getAccessibleInWindow (in nsIDOMNode aNode, in nsIDOMWindow aDOMWin)
 Return an nsIAccessible for a DOM node in pres shell for this DOM window.
nsIAccessible getAccessibleInWeakShell (in nsIDOMNode aNode, in nsIWeakReference aPresShell)
 Return an nsIAccessible for a DOM node in the given weak shell.
nsIAccessible getAccessibleInShell (in nsIDOMNode aNode, in nsIPresShell aPresShell)
 Return an nsIAccessible for a DOM node in the given pres shell.
nsIAccessNode getCachedAccessNode (in nsIDOMNode aNode, in nsIWeakReference aShell)
 Return an nsIAccessNode for an already created DOM node in the given weak shell.
nsIAccessible getCachedAccessible (in nsIDOMNode aNode, in nsIWeakReference aShell)
 Return an nsIAccessible for an already created DOM node in the given weak shell.
AString getStringRole (in unsigned long aRole)
 Returns accessible role as a string.
nsIDOMDOMStringList getStringStates (in unsigned long aStates, in unsigned long aExtraStates)
 Returns list which contains accessible states as a strings.
AString getStringEventType (in unsigned long aEventType)
 Get the type of accessible event as a string.
AString getStringRelationType (in unsigned long aRelationType)
 Get the type of accessible relation as a string.

Detailed Description

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

Status:
UNDER_REVIEW

Member Function Documentation

nsIAccessible nsIAccessibleRetrieval::getAccessibleFor ( in nsIDOMNode  aNode  ) 

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.

Parameters:
aNode The DOM node to get an accessible for.
Returns:
The nsIAccessible for the given DOM node.
nsIAccessible nsIAccessibleRetrieval::getAccessibleInShell ( in nsIDOMNode  aNode,
in nsIPresShell  aPresShell 
)

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.

Parameters:
aNode The DOM node to get an accessible for.
aPresShell The presentation shell which contains layout info for the DOM node.
Returns:
The nsIAccessible for the given DOM node.
nsIAccessible nsIAccessibleRetrieval::getAccessibleInWeakShell ( in nsIDOMNode  aNode,
in nsIWeakReference  aPresShell 
)

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.

Parameters:
aNode The DOM node to get an accessible for.
aPresShell The presentation shell which contains layout info for the DOM node.
Returns:
The nsIAccessible for the given DOM node.
nsIAccessible nsIAccessibleRetrieval::getAccessibleInWindow ( in nsIDOMNode  aNode,
in nsIDOMWindow  aDOMWin 
)

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.

Parameters:
aNode The DOM node to get an accessible for.
aDOMWin The DOM window containing the node.
Returns:
The nsIAccessible for the given DOM node.
nsIAccessible nsIAccessibleRetrieval::getAttachedAccessibleFor ( in nsIDOMNode  aNode  ) 

The same like getAccessibleFor method except it returns accessible only if it is attached, i.e.

accessible is certified to be a descendent of the root accessible.

Parameters:
aNode - the DOM node to get an accessible for.
Returns:
- the accessible for the given DOM node.
nsIAccessible nsIAccessibleRetrieval::getCachedAccessible ( in nsIDOMNode  aNode,
in nsIWeakReference  aShell 
)

Return an nsIAccessible for an already created DOM node in the given weak shell.

Does not create a new one -- only returns cached accessibles.

Parameters:
aNode The DOM node to get an accessible for.
aPresShell The presentation shell which contains layout info for the DOM node.
Returns:
The nsIAccessible for the given DOM node or null if an accessible does not already exist for this DOM node.
nsIAccessNode nsIAccessibleRetrieval::getCachedAccessNode ( in nsIDOMNode  aNode,
in nsIWeakReference  aShell 
)

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.

Parameters:
aNode The DOM node to get an access node for.
aPresShell The presentation shell which contains layout info for the DOM node.
Returns:
The nsIAccessNode for the given DOM node or null if an access node does not already exist for this DOM node.
nsIDOMNode nsIAccessibleRetrieval::getRelevantContentNodeFor ( in nsIDOMNode  aNode  ) 

Return an DOM node that is relevant to attached accesible check.

This node is either from bindings chain if given node is anonymous and owner binding denies accessible in anonymous content or given node (it's not important whether it is accessible or not). This method doesn't create accessible object for returned node.

Parameters:
aNode - the DOM node to get relevant content node.
Returns:
- the DOM node for parent attached accessible
AString nsIAccessibleRetrieval::getStringEventType ( in unsigned long  aEventType  ) 

Get the type of accessible event as a string.

Parameters:
aEventType - the accessible event type constant
Returns:
- accessible event type presented as human readable string
AString nsIAccessibleRetrieval::getStringRelationType ( in unsigned long  aRelationType  ) 

Get the type of accessible relation as a string.

Parameters:
aRelationType - the accessible relation type constant
Returns:
- accessible relation type presented as human readable string
AString nsIAccessibleRetrieval::getStringRole ( in unsigned long  aRole  ) 

Returns accessible role as a string.

Parameters:
aRole - the accessible role constants.
nsIDOMDOMStringList nsIAccessibleRetrieval::getStringStates ( in unsigned long  aStates,
in unsigned long  aExtraStates 
)

Returns list which contains accessible states as a strings.

Parameters:
aStates - accessible states.
aExtraStates - accessible extra states.

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