Public Member Functions | Public Attributes

nsIAccessibleDocument Interface Reference

An interface for in-process accessibility clients that wish to retrieve information about a document. More...

import "nsIAccessibleDocument.idl";

Collaboration diagram for nsIAccessibleDocument:

List of all members.

Public Member Functions

AString getNameSpaceURIForID (in short nameSpaceID)
 The namespace for each ID that is handed back.
nsIAccessNode getCachedAccessNode (in voidPtr aUniqueID)
 Returns the access node cached by this document.
nsIAccessible getAccessibleInParentChain (in nsIDOMNode aDOMNode, in boolean aCanCreate)
 Returns the first accessible parent of a DOM node.

Public Attributes

readonly attribute AString URL
 The URL of the document.
readonly attribute AString title
 The title of the document, as specified in the document.
readonly attribute AString mimeType
 The mime type of the document.
readonly attribute AString docType
 The doc type of the document, as specified in the document.
readonly attribute nsIDOMDocument document
 The nsIDOMDocument interface associated with this document.
readonly attribute nsIDOMWindow window
 The nsIDOMWindow that the document resides in.
readonly attribute voidPtr windowHandle
 The window handle for the OS window the document is being displayed in.

Detailed Description

An interface for in-process accessibility clients that wish to retrieve information about a document.

When accessibility is turned on in Gecko, there is an nsIAccessibleDocument for each document whether it is XUL, HTML or whatever. You can QueryInterface to nsIAccessibleDocument from the nsIAccessible or nsIAccessNode for the root node of a document. You can also get one from nsIAccessNode::GetAccessibleDocument() or nsIAccessibleEvent::GetAccessibleDocument()

Status:
UNDER_REVIEW

Member Function Documentation

nsIAccessible nsIAccessibleDocument::getAccessibleInParentChain ( in nsIDOMNode  aDOMNode,
in boolean  aCanCreate 
)

Returns the first accessible parent of a DOM node.

Guaranteed not to return nsnull if the DOM node is in a document.

Parameters:
aDOMNode The DOM node we need an accessible for.
aCanCreate Can accessibles be created or must it be the first cached accessible in the parent chain?
Returns:
An first nsIAccessible found by crawling up the DOM node to the document root.
nsIAccessNode nsIAccessibleDocument::getCachedAccessNode ( in voidPtr  aUniqueID  ) 

Returns the access node cached by this document.

Parameters:
aUniqueID The unique ID used to cache the node. This matches up with the uniqueID attribute on nsIAccessNode.
Returns:
The nsIAccessNode cached for this particular unique ID.
AString nsIAccessibleDocument::getNameSpaceURIForID ( in short  nameSpaceID  ) 

The namespace for each ID that is handed back.


Member Data Documentation

readonly attribute AString nsIAccessibleDocument::docType

The doc type of the document, as specified in the document.

The nsIDOMDocument interface associated with this document.

readonly attribute AString nsIAccessibleDocument::mimeType

The mime type of the document.

readonly attribute AString nsIAccessibleDocument::title

The title of the document, as specified in the document.

readonly attribute AString nsIAccessibleDocument::URL

The URL of the document.

The nsIDOMWindow that the document resides in.

readonly attribute voidPtr nsIAccessibleDocument::windowHandle

The window handle for the OS window the document is being displayed in.

For example, in Windows you can static cast it to an HWND.


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