mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-29 21:25:35 +00:00
130 lines
4.5 KiB
Plaintext
130 lines
4.5 KiB
Plaintext
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 2002
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Original Author: Aaron Leventhal (aaronl@netscape.com)
|
|
* Contributor(s): John Gaunt (jgaunt@netscape.com)
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface nsIAccessible;
|
|
interface nsIAccessNode;
|
|
interface nsIDOMDocument;
|
|
interface nsIDOMNode;
|
|
interface nsIDOMWindow;
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
[scriptable, uuid(60f8b190-63c4-4919-ac92-a7a8212fc813)]
|
|
interface nsIAccessibleDocument : nsISupports
|
|
{
|
|
/**
|
|
* The URL of the document
|
|
*/
|
|
readonly attribute AString URL;
|
|
|
|
/**
|
|
* The title of the document, as specified in the document.
|
|
*/
|
|
readonly attribute AString title;
|
|
|
|
/**
|
|
* The mime type of the document
|
|
*/
|
|
readonly attribute AString mimeType;
|
|
|
|
/**
|
|
* The doc type of the document, as specified in the document.
|
|
*/
|
|
readonly attribute AString docType;
|
|
|
|
/**
|
|
* The nsIDOMDocument interface associated with this document.
|
|
*/
|
|
readonly attribute nsIDOMDocument document;
|
|
|
|
/**
|
|
* The nsIDOMWindow that the document resides in.
|
|
*/
|
|
readonly attribute nsIDOMWindow window;
|
|
|
|
/*
|
|
* The accessible for the caret belonging to this window.
|
|
*/
|
|
readonly attribute nsIAccessible caretAccessible;
|
|
|
|
/**
|
|
* The namespace for each ID that is handed back.
|
|
*/
|
|
AString getNameSpaceURIForID(in short nameSpaceID);
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
[noscript] readonly attribute voidPtr windowHandle;
|
|
|
|
/**
|
|
* Returns the access node cached by this document
|
|
* @param aUniqueID The unique ID used to cache the node.
|
|
* This matches up with the uniqueID attribute on
|
|
* nsIAccessNode.
|
|
* @return The nsIAccessNode cached for this particular unique ID.
|
|
*/
|
|
[noscript] nsIAccessNode getCachedAccessNode(in voidPtr aUniqueID);
|
|
|
|
/**
|
|
* Returns the first accessible parent of a DOM node.
|
|
* Guaranteed not to return nsnull if the DOM node is in a document.
|
|
* @param aDOMNode The DOM node we need an accessible for.
|
|
* @param aCanCreate Can accessibles be created or must it be the first
|
|
* cached accessible in the parent chain?
|
|
* @return An first nsIAccessible found by crawling up the DOM node
|
|
* to the document root.
|
|
*/
|
|
nsIAccessible getAccessibleInParentChain(in nsIDOMNode aDOMNode, in boolean aCanCreate);
|
|
};
|