accessible/public/nsIAccessibleTypes.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  * Mozilla Foundation.
  19  * Portions created by the Initial Developer are Copyright (C) 2007
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Alexander Surkov <surkov.alexander@gmail.com> (original author)
  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 /**
  42  * These constants control the scrolling of an object or substring into a
  43  * window. Note, keep them synchronized with IA2ScrollType.
  44  */
  45 [scriptable, uuid(05cd38b1-94b3-4cdf-8371-3935a9611405)]
  46 interface nsIAccessibleScrollType : nsISupports
  47 {
  48   /**
  49    * Scroll the top left of the object or substring to the top left of the
  50    * window (or as close as possible).
  51    */
  52   const unsigned long SCROLL_TYPE_TOP_LEFT =0x00;
  53
  54   /**
  55    * Scroll the bottom right of the object or substring to the bottom right of
  56    * the window (or as close as possible).
  57    */
  58   const unsigned long SCROLL_TYPE_BOTTOM_RIGHT = 0x01;
  59
  60   /**
  61    * Scroll the top edge of the object or substring to the top edge of the
  62    * window (or as close as possible).
  63    */
  64   const unsigned long SCROLL_TYPE_TOP_EDGE = 0x02;
  65
  66   /**
  67    * Scroll the bottom edge of the object or substring to the bottom edge of
  68    * the window (or as close as possible).
  69    */
  70   const unsigned long SCROLL_TYPE_BOTTOM_EDGE = 0x03;
  71
  72   /**
  73    * Scroll the left edge of the object or substring to the left edge of the
  74    * window (or as close as possible).
  75    */
  76   const unsigned long SCROLL_TYPE_LEFT_EDGE =0x04;
  77
  78   /**
  79    * Scroll the right edge of the object or substring to the right edge of the
  80    * window (or as close as possible).
  81    */
  82   const unsigned long SCROLL_TYPE_RIGHT_EDGE = 0x05;
  83
  84   /**
  85    * Scroll an object the minimum amount necessary in order for the entire
  86    * frame to be visible (if possible).
  87    */
  88   const unsigned long SCROLL_TYPE_ANYWHERE = 0x06;
  89 };
  90
  91
  92 /**
  93  * These constants define which coordinate system a point is located in.
  94  */
  95 [scriptable, uuid(c9fbdf10-619e-436f-bf4b-8566686f1577)]
  96 interface nsIAccessibleCoordinateType : nsISupports
  97 {
  98   /**
  99    * The coordinates are relative to the screen.
 100    */
 101   const unsigned long COORDTYPE_SCREEN_RELATIVE = 0x00;
 102
 103   /**
 104    * The coordinates are relative to the window.
 105    */
 106   const unsigned long COORDTYPE_WINDOW_RELATIVE = 0x01;
 107
 108   /**
 109    * The coordinates are relative to the upper left corner of the bounding box
 110    * of the immediate parent.
 111    */
 112   const unsigned long COORDTYPE_PARENT_RELATIVE = 0x02;
 113 };
 114