accessible/interfaces/nsIAccessibleHyperText.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsISupports.idl"
   8 #include "nsIAccessibleHyperLink.idl"
   9
  10 /**
  11  * A cross-platform interface that deals with text which contains hyperlinks.
  12  * Each link is an embedded object representing exactly 1 character within
  13  * the hypertext.
  14  *
  15  * Current implementation assumes every embedded object is a link.
  16  */
  17
  18 [scriptable, builtinclass, uuid(b33684e2-090c-4e1d-a3d9-f4b46f4237b9)]
  19 interface nsIAccessibleHyperText : nsISupports
  20 {
  21   /**
  22    * Return the number of links contained within this hypertext object.
  23    */
  24   readonly attribute long linkCount;
  25
  26   /**
  27    * Return link accessible at the given index.
  28    *
  29    * @param index  [in] 0-based index of the link that is to be retrieved
  30    *
  31    * @return       link accessible or null if there is no link at that index
  32    */
  33   nsIAccessibleHyperLink getLinkAt(in long index);
  34
  35   /**
  36    * Return index of the given link.
  37    *
  38    * @param link  [in] link accessible the index is requested for
  39    *
  40    * @return      index of the given link or null if there's no link within
  41    *                hypertext accessible
  42    */
  43   long getLinkIndex(in nsIAccessibleHyperLink link);
  44
  45   /*
  46    * Return link index at the given offset within hypertext accessible.
  47    *
  48    * @param offset  [in] the 0-based character index
  49    *
  50    * @return        0-based link's index or -1 if no link is present at that
  51    *                  offset
  52    */
  53   long getLinkIndexAtOffset(in long offset);
  54 };