Back to index

lightning-sunbird  0.9+nobinonly
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";

Inheritance diagram for nsIAccessibleDocument:
Inheritance graph
[legend]
Collaboration diagram for nsIAccessibleDocument:
Collaboration graph
[legend]

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)
 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 boolean isEditable
 True if the document is live in an editor.
readonly attribute nsIDOMDocument document
 The nsIDOMDocument interface associated with this document.
readonly attribute nsIDOMWindow window
 The nsIDOMWindow that the document resides in.
readonly attribute nsIAccessible caretAccessible
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()

UNDER_REVIEW

Definition at line 62 of file nsIAccessibleDocument.idl.


Member Function Documentation

Returns the first accessible parent of a DOM node.

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

Parameters:
aDOMNodeThe DOM node we need an accessible for.
Returns:
An first nsIAccessible found by crawling up the DOM node to the document root.

Returns the access node cached by this document.

Parameters:
aUniqueIDThe 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

Definition at line 105 of file nsIAccessibleDocument.idl.

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

Definition at line 82 of file nsIAccessibleDocument.idl.

The nsIDOMDocument interface associated with this document.

Definition at line 95 of file nsIAccessibleDocument.idl.

True if the document is live in an editor.

False if the document is being displayed but not edited. If a

is contentEditable, then it has its own document, with isEditable == true.

Definition at line 90 of file nsIAccessibleDocument.idl.

The mime type of the document.

Definition at line 77 of file nsIAccessibleDocument.idl.

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

Definition at line 72 of file nsIAccessibleDocument.idl.

The URL of the document.

Definition at line 67 of file nsIAccessibleDocument.idl.

The nsIDOMWindow that the document resides in.

Definition at line 100 of file nsIAccessibleDocument.idl.

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.

Definition at line 116 of file nsIAccessibleDocument.idl.


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