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