accessible/public/nsIAccessibleHyperText.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Mozilla browser.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Bill Haneman (bill.haneman@sun.com)
  25  *   Paul Sandoz (paul.sandoz@sun.com)
  26  *   John Gaunt (jgaunt@netscape.com)
  27  *
  28  * Alternatively, the contents of this file may be used under the terms of
  29  * either of the GNU General Public License Version 2 or later (the "GPL"),
  30  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  31  * in which case the provisions of the GPL or the LGPL are applicable instead
  32  * of those above. If you wish to allow use of your version of this file only
  33  * under the terms of either the GPL or the LGPL, and not to allow others to
  34  * use your version of this file under the terms of the MPL, indicate your
  35  * decision by deleting the provisions above and replace them with the notice
  36  * and other provisions required by the GPL or the LGPL. If you do not delete
  37  * the provisions above, a recipient may use your version of this file under
  38  * the terms of any one of the MPL, the GPL or the LGPL.
  39  *
  40  * ***** END LICENSE BLOCK ***** */
  41
  42 #include "nsISupports.idl"
  43 #include "nsIAccessibleHyperLink.idl"
  44
  45 /**
  46  * A cross-platform interface that deals with text which contains hyperlinks.
  47  */
  48
  49 [scriptable, uuid(d56bd454-8ff3-4edc-b266-baeada00267b)]
  50 interface nsIAccessibleHyperText : nsISupports
  51 {
  52   /**
  53    * Returns the number of links contained within this hypertext object.
  54    */
  55   readonly attribute long linkCount;
  56
  57   /*
  58    * Returns the link index at the given character index.
  59    * Each link is an embedded object representing exactly 1 character within
  60    * the hypertext.
  61    *
  62    * @param charIndex  the 0-based character index.
  63    *
  64    * @returns long  0-based link's index.
  65    * A return value of -1 indicates no link is present at that index.
  66    */
  67   long getLinkIndex(in long charIndex);
  68
  69   /**
  70    * Retrieves the nsIAccessibleHyperLink object at the given link index.
  71    *
  72    * @param linkIndex  0-based index of the link that is to be retrieved.
  73    * This can be retrieved via getLinkIndex (see above).
  74    *
  75    * @returns nsIAccessibleHyperLink  Object representing the link properties
  76    * or NS_ERROR_INVALID_ARG if there is no link at that index.
  77    */
  78   nsIAccessibleHyperLink getLink(in long linkIndex);
  79 };