other-licenses/ia2/AccessibleHyperlink.idl

   1 /*************************************************************************
   2  *
   3  *  File Name (AccessibleHyperlink.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 "AccessibleAction.idl";
  30
  31 /** @brief This interface represents hyperlinks.
  32
  33  This interface represents a hyperlink associated with a single substring
  34   of text or single non-text object.  Non-text objects can have either a
  35   single link or a collection of links such as when the non-text object is
  36   an image map.
  37
  38  Linked objects and anchors are implementation dependent. This interface is
  39   derived from IAccessibleAction.  IAccessibleAction::nActions indicates the
  40   maximum value for the indices used with the methods of this interface.
  41
  42  Furthermore, the object that implements this interface has to be connected
  43   implicitly or explicitly with an object that implements IAccessibleText.
  44   IAccessibleHyperlink::startIndex and IAccessibleHyperlink::endIndex are
  45   indices with respect to the text exposed by IAccessibleText.
  46 */
  47 [object, uuid(01C20F2B-3DD2-400f-949F-AD00BDAB1D41)]
  48 interface IAccessibleHyperlink : IAccessibleAction
  49 {
  50
  51   /** @brief Returns an object that represents the link anchor, as appropriate
  52    for the link at the specified index.
  53    @param [in] index
  54     A 0 based index identifies the anchor when, as in the case of an image map,
  55     there is more than one link represented by this object.  The valid maximal
  56     index is indicated by IAccessibleAction::nActions.
  57    @param [out] anchor
  58     This is an implementation dependent value.  For example, for a text link this
  59         method could return the substring of the containing string where the subsgtring
  60         is overridden with link behavior, and for an image link this method could return
  61         an IUnknown VARIANT for IAccessibleImage.
  62   */
  63   [propget] HRESULT anchor
  64     (
  65      [in] long index,
  66      [out, retval] VARIANT *anchor
  67     );
  68
  69   /** @brief Returns an object representing the target of the link, as appropriate
  70    for the link at the specified index.
  71    @param [in] index
  72     A 0 based index identifies the anchor when, as in the case of an image map,
  73     there is more than one link represented by this object.  The valid maximal
  74     index is indicated by IAccessibleAction::nActions.
  75    @param [out] anchorTarget
  76     This is an implementation dependent value.  For example this method could
  77         return a BSTR VARIANT of the URI.  Alternatively this method could return an
  78         IUnknown VARIANT of a COM interface representing a target object to be
  79         activated when the link is activated.
  80   */
  81   [propget] HRESULT anchorTarget
  82     (
  83      [in] long index,
  84      [out, retval] VARIANT *anchorTarget
  85     );
  86
  87   /** @brief Returns the index at which the textual representation of the hyperlink starts.
  88
  89    The returned value is related to the IAccessibleText interface of the object that
  90    owns this hyperlink.
  91    @param [out] index
  92   */
  93   [propget] HRESULT startIndex
  94     (
  95      [out, retval] long *index
  96     );
  97
  98   /** @brief Returns the index at which the textual rerpesentation of the hyperlink ends.
  99
 100    The returned value is related to the IAccessibleText interface of the object that
 101    owns this hyperlink. The character at the index is not part of the hypertext.
 102    @param [out] index
 103   */
 104   [propget] HRESULT endIndex
 105     (
 106      [out, retval] long *index
 107     );
 108
 109   /** @brief Returns whether the target object referenced by this link is still valid.
 110
 111    This is a volatile state that may change without sending an appropriate event.
 112    Returns TRUE if the referenced target is still valid and FALSE otherwise.
 113
 114    @param [out] valid
 115   */
 116   [propget] HRESULT valid
 117     (
 118      [out, retval] boolean *valid
 119     );
 120 }