|
1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- |
|
2 /* This Source Code Form is subject to the terms of the Mozilla Public |
|
3 * License, v. 2.0. If a copy of the MPL was not distributed with this |
|
4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
|
5 |
|
6 #include "nsISupports.idl" |
|
7 |
|
8 interface nsIAccessible; |
|
9 interface nsIAccessiblePivot; |
|
10 interface nsIDOMDocument; |
|
11 interface nsIDOMNode; |
|
12 interface nsIDOMWindow; |
|
13 |
|
14 /** |
|
15 * An interface for in-process accessibility clients |
|
16 * that wish to retrieve information about a document. |
|
17 * When accessibility is turned on in Gecko, |
|
18 * there is an nsIAccessibleDocument for each document |
|
19 * whether it is XUL, HTML or whatever. |
|
20 * You can QueryInterface to nsIAccessibleDocument from the nsIAccessible for |
|
21 * the root node of a document. You can also get one from |
|
22 * nsIAccessible::GetAccessibleDocument() or |
|
23 * nsIAccessibleEvent::GetAccessibleDocument() |
|
24 */ |
|
25 [scriptable, uuid(fe5b3886-2b6a-491a-80cd-a3e6342c451d)] |
|
26 interface nsIAccessibleDocument : nsISupports |
|
27 { |
|
28 /** |
|
29 * The URL of the document |
|
30 */ |
|
31 readonly attribute AString URL; |
|
32 |
|
33 /** |
|
34 * The title of the document, as specified in the document. |
|
35 */ |
|
36 readonly attribute AString title; |
|
37 |
|
38 /** |
|
39 * The mime type of the document |
|
40 */ |
|
41 readonly attribute AString mimeType; |
|
42 |
|
43 /** |
|
44 * The doc type of the document, as specified in the document. |
|
45 */ |
|
46 readonly attribute AString docType; |
|
47 |
|
48 /** |
|
49 * The nsIDOMDocument interface associated with this document. |
|
50 */ |
|
51 readonly attribute nsIDOMDocument DOMDocument; |
|
52 |
|
53 /** |
|
54 * The nsIDOMWindow that the document resides in. |
|
55 */ |
|
56 readonly attribute nsIDOMWindow window; |
|
57 |
|
58 /** |
|
59 * The namespace for each ID that is handed back. |
|
60 */ |
|
61 AString getNameSpaceURIForID(in short nameSpaceID); |
|
62 |
|
63 /** |
|
64 * The window handle for the OS window the document is being displayed in. |
|
65 * For example, in Windows you can static cast it to an HWND. |
|
66 */ |
|
67 [noscript] readonly attribute voidPtr windowHandle; |
|
68 |
|
69 /** |
|
70 * Return the parent document accessible. |
|
71 */ |
|
72 readonly attribute nsIAccessibleDocument parentDocument; |
|
73 |
|
74 /** |
|
75 * Return the count of child document accessibles. |
|
76 */ |
|
77 readonly attribute unsigned long childDocumentCount; |
|
78 |
|
79 /** |
|
80 * The virtual cursor pivot this document manages. |
|
81 */ |
|
82 readonly attribute nsIAccessiblePivot virtualCursor; |
|
83 |
|
84 /** |
|
85 * Return the child document accessible at the given index. |
|
86 */ |
|
87 nsIAccessibleDocument getChildDocumentAt(in unsigned long index); |
|
88 }; |