accessible/interfaces/nsIAccessibleDocument.idl

   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 nsIAccessiblePivot;
   9 interface mozIDOMWindowProxy;
  10
  11 webidl Document;
  12
  13 /**
  14  * An interface for in-process accessibility clients
  15  * that wish to retrieve information about a document.
  16  * When accessibility is turned on in Gecko,
  17  * there is an nsIAccessibleDocument for each document
  18  * whether it is XUL, HTML or whatever.
  19  * You can QueryInterface to nsIAccessibleDocument from the nsIAccessible for
  20  * the root node of a document or you can get one from
  21  * nsIAccessible::GetDocument().
  22  */
  23 [scriptable, builtinclass, uuid(5cad5f91-fcce-40e7-913e-4671701d19b4)]
  24 interface nsIAccessibleDocument : nsISupports
  25 {
  26   /**
  27    * The URL of the document
  28    */
  29   readonly attribute AString URL;
  30
  31   /**
  32    * The title of the document, as specified in the document.
  33    */
  34   readonly attribute AString title;
  35
  36   /**
  37    * The mime type of the document
  38    */
  39   readonly attribute AString mimeType;
  40
  41   /**
  42    * The doc type of the document, as specified in the document.
  43    */
  44   readonly attribute AString docType;
  45
  46   /**
  47    * The Document interface associated with this document.
  48    */
  49   readonly attribute Document DOMDocument;
  50
  51   /**
  52    * The nsIDOMWindow that the document resides in.
  53    */
  54   readonly attribute mozIDOMWindowProxy window;
  55
  56   /**
  57    * Return the parent document accessible.
  58    */
  59   readonly attribute nsIAccessibleDocument parentDocument;
  60
  61   /**
  62    * Return the count of child document accessibles.
  63    */
  64   readonly attribute unsigned long childDocumentCount;
  65
  66   /**
  67    * Return the child document accessible at the given index.
  68    */
  69   nsIAccessibleDocument getChildDocumentAt(in unsigned long index);
  70 };