accessible/interfaces/nsIAccessibleTextRange.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 nsIAccessible;
   9 interface nsIAccessibleText;
  10 interface nsIArray;
  11 interface nsIVariant;
  12
  13 /**
  14  * A range representing a piece of text in the document.
  15  */
  16 [scriptable, builtinclass, uuid(c4515623-55f9-4543-a3d5-c1e9afa588f4)]
  17 interface nsIAccessibleTextRange : nsISupports
  18 {
  19   readonly attribute nsIAccessibleText startContainer;
  20   readonly attribute long startOffset;
  21   readonly attribute nsIAccessibleText endContainer;
  22   readonly attribute long endOffset;
  23
  24   /**
  25    * Return an accessible containing the whole range
  26    */
  27   readonly attribute nsIAccessible container;
  28
  29   /**
  30    * Return embedded children within the range.
  31    */
  32   readonly attribute nsIArray embeddedChildren;
  33
  34   /**
  35    * Return true if this range has the same end points of the given range.
  36    */
  37   boolean compare(in nsIAccessibleTextRange aOtherRange);
  38
  39   /**
  40    * The two endpoints of the range (starting and ending).
  41    */
  42   const unsigned long EndPoint_Start = 1;
  43   const unsigned long EndPoint_End = 2;
  44
  45   /**
  46    * Compare this and given ranges end points.
  47    *
  48    * @return -1/0/1 if this range end point is before/equal/after the given
  49    *          range end point.
  50    */
  51   long compareEndPoints(in unsigned long aEndPoint,
  52                         in nsIAccessibleTextRange aOtherRange,
  53                         in unsigned long aOtherRangeEndPoint);
  54
  55   /**
  56    * Return text within the range.
  57    */
  58   readonly attribute AString text;
  59
  60   /**
  61    * Return list of rects of the range.
  62    */
  63   readonly attribute nsIArray bounds;
  64
  65   const unsigned long FormatUnit = 0;
  66   const unsigned long WordUnit = 1;
  67   const unsigned long LineUnit = 2;
  68   const unsigned long ParagraphUnit = 3;
  69   const unsigned long PageUnit = 4;
  70   const unsigned long DocumentUnit = 5;
  71
  72   /**
  73    *  Move the boundary(ies) by the given number of the unit.
  74    */
  75   void move(in unsigned long aUnit, in long aCount);
  76   void moveStart(in unsigned long aUnit, in long aCount);
  77   void moveEnd(in unsigned long aUnit, in long aCount);
  78
  79   /**
  80    * Normalize the range to the closest unit of the given type.
  81    */
  82   void normalize(in unsigned long aUnit);
  83
  84   /**
  85    * Crops the range by the given accessible element.
  86    */
  87   boolean crop(in nsIAccessible aContainer);
  88
  89   /**
  90    * Return range enclosing the found text.
  91    */
  92   nsIAccessibleTextRange findText(in AString aText, in boolean aIsBackward,
  93                                   in boolean aIsIgnoreCase);
  94
  95   /**
  96    * Text attributes. Used in conjunction with findAttrs().
  97    */
  98   const unsigned long AnimationStyleAttr = 0;
  99   const unsigned long AnnotationObjectsAttr = 1;
 100   const unsigned long AnnotationTypesAttr = 2;
 101   const unsigned long BackgroundColorAttr = 3;
 102   const unsigned long BulletStyleAttr = 4;
 103   const unsigned long CapStyleAttr = 5;
 104   const unsigned long CaretBidiModeAttr = 6;
 105   const unsigned long CaretPositionAttr = 7;
 106   const unsigned long CultureAttr = 8;
 107   const unsigned long FontNameAttr = 9;
 108   const unsigned long FontSizeAttr = 10;
 109   const unsigned long FontWeightAttr = 11;
 110   const unsigned long ForegroundColorAttr = 12;
 111   const unsigned long HorizontalTextAlignmentAttr = 13;
 112   const unsigned long IndentationFirstLineAttr = 14;
 113   const unsigned long IndentationLeadingAttr = 15;
 114   const unsigned long IndentationTrailingAttr = 16;
 115   const unsigned long IsActiveAttr = 17;
 116   const unsigned long IsHiddenAttr = 18;
 117   const unsigned long IsItalicAttr = 19;
 118   const unsigned long IsReadOnlyAttr = 20;
 119   const unsigned long IsSubscriptAttr = 21;
 120   const unsigned long IsSuperscriptAttr = 22;
 121   const unsigned long LinkAttr = 23;
 122   const unsigned long MarginBottomAttr = 24;
 123   const unsigned long MarginLeadingAttr = 25;
 124   const unsigned long MarginTopAttr = 26;
 125   const unsigned long MarginTrailingAttr = 27;
 126   const unsigned long OutlineStylesAttr = 28;
 127   const unsigned long OverlineColorAttr = 29;
 128   const unsigned long OverlineStyleAttr = 30;
 129   const unsigned long SelectionActiveEndAttr = 31;
 130   const unsigned long StrikethroughColorAttr = 32;
 131   const unsigned long StrikethroughStyleAttr = 33;
 132   const unsigned long StyleIdAttr = 34;
 133   const unsigned long StyleNameAttr = 35;
 134   const unsigned long TabsAttr = 36;
 135   const unsigned long TextFlowDirectionsAttr = 37;
 136   const unsigned long UnderlineColorAttr = 38;
 137   const unsigned long UnderlineStyleAttr = 39;
 138
 139   /**
 140    * Return range enslosing the text having requested attribute.
 141    */
 142   nsIAccessibleTextRange findAttr(in unsigned long aAttr, in nsIVariant aValue,
 143                                   in boolean aIsBackward);
 144
 145   /**
 146    * Add/remove the text range from selection.
 147    */
 148   void addToSelection();
 149   void removeFromSelection();
 150   void select();
 151
 152   const unsigned long AlignToTop = 0;
 153   const unsigned long AlignToBottom = 1;
 154
 155   /**
 156    * Scroll the range into view.
 157    */
 158   void scrollIntoView(in unsigned long aHow);
 159 };