other-licenses/ia2/AccessibleHypertext.idl

   1 /*************************************************************************
   2  *
   3  *  File Name (AccessibleHypertext.idl)
   4  *
   5  *  IAccessible2 IDL Specification
   6  *
   7  *  Copyright (c) IBM Corp. 2006
   8  *  Copyright (c) Sun Microsystems, Inc. 2000, 2006
   9  *
  10  *  This library is free software; you can redistribute it and/or
  11  *  modify it under the terms of the GNU Lesser General Public
  12  *  License version 2.1, as published by the Free Software Foundation; either
  13  *  version 2.1 of the License, or (at your option) any later version.
  14  *
  15  *  This library is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  *  Lesser General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU Lesser General Public
  21  *  License along with this library; if not, write to the Free Software
  22  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02110-1301  USA
  23  *
  24  ************************************************************************/
  25
  26 import "objidl.idl";
  27 import "oaidl.idl";
  28 import "oleacc.idl";
  29 import "AccessibleText.idl";
  30 import "AccessibleHyperlink.idl";
  31
  32 /** @brief This interface exposes information about hypertext in a document.
  33
  34  The IAccessibleHypertext interface is the main interface to expose
  35   hyperlinks in a document, typically a text document, that are used
  36   to reference other documents.  A typical implementation is to implement
  37   this interface the smallest text object such as a paragraph of text.
  38 */
  39 [object, uuid(6B4F8BBF-F1F2-418a-B35E-A195BC4103B9)]
  40 interface IAccessibleHypertext : IAccessibleText
  41 {
  42
  43   /** @brief Returns the number of links and link groups contained within this hypertext
  44     paragraph.
  45    @param [out] hyperlinkCount
  46     The number of links and link groups within this hypertext paragraph.
  47     Returns 0 if there is no link.
  48   */
  49   [propget] HRESULT nHyperlinks
  50     (
  51      [out, retval] long *hyperlinkCount
  52     );
  53
  54   /** @brief Returns the specified link.
  55
  56    The returned IAccessibleHyperlink object encapsulates the hyperlink and
  57     provides several kinds of information describing it.
  58    @param [in] index
  59     This 0 based index specifies the hyperlink to return.
  60    @param [out] hyperlink
  61     If the given index is valid, i.e. lies in the interval from 0 to the number
  62     of links minus one, a reference to the specified hyperlink object is returned.
  63     If the index is invalid then a NULL pointer is returned.
  64   */
  65   [propget] HRESULT hyperlink
  66     (
  67      [in] long index,
  68      [out, retval] IAccessibleHyperlink **hyperlink
  69     );
  70
  71   /** @brief Returns the index of the hyperlink that is associated with this character index.
  72
  73    This is the case when a link spans the given character index.
  74    @param [in] charIndex
  75     A 0 based index of the character for which to return the link index.  If
  76         IAccessibleText is used to represent the text containing the link, then the
  77         character index is only  valid if it is greater than or equal to zero and
  78         lower than the number of characters in the text.
  79    @param [out] hyperlinkIndex
  80     Returns the 0 based index of the hyperlink that is associated with this
  81         character index, or -1 if charIndex is not on a link.
  82   */
  83   [propget] HRESULT hyperlinkIndex
  84     (
  85      [in] long charIndex,
  86      [out, retval] long *hyperlinkIndex
  87     );
  88
  89 }