accessible/public/nsIAccessNode.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2003
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Original Author: Aaron Leventhal (aaronl@netscape.com)
  23  * Contributor(s):
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsIDOMNode;
  42 interface nsIAccessibleDocument;
  43 interface nsIDOMCSSPrimitiveValue;
  44
  45 /**
  46  * An interface used by in-process accessibility clients
  47  * to get style, window, markup and other information about
  48  * a DOM node. When accessibility is active in Gecko,
  49  * every DOM node can have one nsIAccessNode for each
  50  * pres shell the DOM node is rendered in.
  51  * The nsIAccessNode implementations are instantiated lazily.
  52  * The nsIAccessNode tree for a given dom window
  53  * has a one to one relationship to the DOM tree.
  54  * If the DOM node for this access node is "accessible",
  55  * then a QueryInterface to nsIAccessible will succeed.
  56  *
  57  * @status UNDER_REVIEW
  58  */
  59 [scriptable, uuid(71a3b4e7-e83d-45cf-a20e-9ce292bcf19f)]
  60 interface nsIAccessNode : nsISupports
  61 {
  62   /**
  63    * The DOM node this nsIAccessNode is associated with.
  64    */
  65   readonly attribute nsIDOMNode DOMNode;
  66
  67   /**
  68    * The number of DOM children for the DOM node, which
  69    * matches the number of nsIAccessNode children for this
  70    * nsIAccessNode.
  71    */
  72   readonly attribute long numChildren;
  73
  74   /**
  75    * Get the nth child of this node
  76    * @param childNum Zero-based child index
  77    * @return The nth nsIAccessNode child
  78    */
  79   nsIAccessNode getChildNodeAt(in long childNum);
  80
  81   /**
  82    * The parent nsIAccessNode
  83    */
  84   readonly attribute nsIAccessNode parentNode;
  85
  86   /**
  87    * The first nsIAccessNode child
  88    */
  89   readonly attribute nsIAccessNode firstChildNode;
  90
  91   /**
  92    * The last nsIAccessNode child
  93    */
  94   readonly attribute nsIAccessNode lastChildNode;
  95
  96   /**
  97    * The previous nsIAccessNode sibling
  98    */
  99   readonly attribute nsIAccessNode previousSiblingNode;
 100
 101   /**
 102    * The next nsIAccessNode sibling
 103    */
 104   readonly attribute nsIAccessNode nextSiblingNode;
 105
 106   /**
 107    * The nsIAccessibleDocument that this nsIAccessNode
 108    * resides in.
 109    */
 110   readonly attribute nsIAccessibleDocument accessibleDocument;
 111
 112   /**
 113    * The innerHTML for the DOM node
 114    * This is a text string of all the markup inside the DOM
 115    * node, not including the start and end tag for the node.
 116    */
 117   readonly attribute DOMString innerHTML;
 118
 119   /**
 120    * Makes an object visible on screen.
 121    *
 122    * @param scrollType - defines where the object should be placed on
 123    *                     the screen (see nsIAccessibleScrollType for
 124    *                     available constants).
 125    */
 126   void scrollTo(in unsigned long aScrollType);
 127
 128   /**
 129    * Moves the top left of an object to a specified location.
 130    *
 131    * @param coordinateType - specifies whether the coordinates are relative to
 132    *                         the screen or the parent object (for available
 133    *                         constants refer to nsIAccessibleCoordinateType)
 134    * @param aX - defines the x coordinate
 135    * @param aY - defines the y coordinate
 136   */
 137   void scrollToPoint(in unsigned long aCoordinateType, in long aX, in long aY);
 138
 139   /**
 140    * The OS window handle for the window this node
 141    * is being displayed in.
 142    */
 143   [noscript] readonly attribute voidPtr ownerWindow;
 144
 145   /**
 146    * A unique ID calculated for this DOM node, for the
 147    * purposes of caching and referencing this object.
 148    */
 149   [noscript] readonly attribute voidPtr uniqueID;
 150
 151   /**
 152    * Retrieve the computed style value for this DOM node, if it is a DOM element.
 153    * Note: the meanings of width, height and other size measurements depend
 154    * on the version of CSS being used. Therefore, for bounds information,
 155    * it is better to use nsIAccessible::accGetBounds.
 156    * @param pseudoElt The pseudo element to retrieve style for, or NULL
 157    *                  for general computed style information for this node.
 158    * @param propertyName Retrieve the computed style value for this property name,
 159    *                     for example "border-bottom".
 160    */
 161   DOMString getComputedStyleValue(in DOMString pseudoElt, in DOMString propertyName);
 162
 163   /**
 164    * The method is similar to getComputedStyleValue() excepting that this one
 165    * returns nsIDOMCSSPrimitiveValue.
 166    */
 167   nsIDOMCSSPrimitiveValue getComputedStyleCSSValue(in DOMString pseudoElt,
 168                                                    in DOMString propertyName);
 169
 170   /**
 171    * The language for the current DOM node, e.g. en, de, etc.
 172    */
 173   readonly attribute DOMString language;
 174 };
 175