1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/accessible/public/nsIAccessibleDocument.idl Wed Dec 31 06:09:35 2014 +0100 1.3 @@ -0,0 +1,88 @@ 1.4 +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- 1.5 +/* This Source Code Form is subject to the terms of the Mozilla Public 1.6 + * License, v. 2.0. If a copy of the MPL was not distributed with this 1.7 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ 1.8 + 1.9 +#include "nsISupports.idl" 1.10 + 1.11 +interface nsIAccessible; 1.12 +interface nsIAccessiblePivot; 1.13 +interface nsIDOMDocument; 1.14 +interface nsIDOMNode; 1.15 +interface nsIDOMWindow; 1.16 + 1.17 +/** 1.18 + * An interface for in-process accessibility clients 1.19 + * that wish to retrieve information about a document. 1.20 + * When accessibility is turned on in Gecko, 1.21 + * there is an nsIAccessibleDocument for each document 1.22 + * whether it is XUL, HTML or whatever. 1.23 + * You can QueryInterface to nsIAccessibleDocument from the nsIAccessible for 1.24 + * the root node of a document. You can also get one from 1.25 + * nsIAccessible::GetAccessibleDocument() or 1.26 + * nsIAccessibleEvent::GetAccessibleDocument() 1.27 + */ 1.28 +[scriptable, uuid(fe5b3886-2b6a-491a-80cd-a3e6342c451d)] 1.29 +interface nsIAccessibleDocument : nsISupports 1.30 +{ 1.31 + /** 1.32 + * The URL of the document 1.33 + */ 1.34 + readonly attribute AString URL; 1.35 + 1.36 + /** 1.37 + * The title of the document, as specified in the document. 1.38 + */ 1.39 + readonly attribute AString title; 1.40 + 1.41 + /** 1.42 + * The mime type of the document 1.43 + */ 1.44 + readonly attribute AString mimeType; 1.45 + 1.46 + /** 1.47 + * The doc type of the document, as specified in the document. 1.48 + */ 1.49 + readonly attribute AString docType; 1.50 + 1.51 + /** 1.52 + * The nsIDOMDocument interface associated with this document. 1.53 + */ 1.54 + readonly attribute nsIDOMDocument DOMDocument; 1.55 + 1.56 + /** 1.57 + * The nsIDOMWindow that the document resides in. 1.58 + */ 1.59 + readonly attribute nsIDOMWindow window; 1.60 + 1.61 + /** 1.62 + * The namespace for each ID that is handed back. 1.63 + */ 1.64 + AString getNameSpaceURIForID(in short nameSpaceID); 1.65 + 1.66 + /** 1.67 + * The window handle for the OS window the document is being displayed in. 1.68 + * For example, in Windows you can static cast it to an HWND. 1.69 + */ 1.70 + [noscript] readonly attribute voidPtr windowHandle; 1.71 + 1.72 + /** 1.73 + * Return the parent document accessible. 1.74 + */ 1.75 + readonly attribute nsIAccessibleDocument parentDocument; 1.76 + 1.77 + /** 1.78 + * Return the count of child document accessibles. 1.79 + */ 1.80 + readonly attribute unsigned long childDocumentCount; 1.81 + 1.82 + /** 1.83 + * The virtual cursor pivot this document manages. 1.84 + */ 1.85 + readonly attribute nsIAccessiblePivot virtualCursor; 1.86 + 1.87 + /** 1.88 + * Return the child document accessible at the given index. 1.89 + */ 1.90 + nsIAccessibleDocument getChildDocumentAt(in unsigned long index); 1.91 +};