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

List of all members.

Public Member Functions
nsIAccessible	getApplicationAccessible ()
	Return application accessible.
nsIAccessible	getAccessibleFor (in nsIDOMNode aNode)
	Return an nsIAccessible for a DOM node in pres shell 0.
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.
nsIAccessible	getAccessibleFromCache (in nsIDOMNode aNode)
	Return an accessible for the given DOM node from the cache.

---

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

---

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::getAccessibleFromCache

(

in nsIDOMNode

aNode

)

Return an accessible for the given DOM node from the cache.

Note:

the method is intended for testing purposes

Parameters:

aNode

[in] the DOM node to get an accessible for

Returns:

cached accessible for the given DOM node if any

nsIAccessible nsIAccessibleRetrieval::getApplicationAccessible

(

)

Return application 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:

• nsIAccessibleRetrieval.idl