xml/Accessibility_Hypertext.xml

   1 <node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
   2
   3 <tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
   4 <tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
   5 <tp:copyright>Copyright 2001 Sun Microsystems, Inc.</tp:copyright>
   6 <tp:license xmlns="http://www.w3.org/1999/xhtml">
   7   <p>This library is free software; you can redistribute it and/or
   8     modify it under the terms of the GNU Library General Public
   9     License as published by the Free Software Foundation; either
  10     version 2 of the License, or (at your option) any later version.</p>
  11
  12   <p>This library is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15     Library General Public License for more details.</p>
  16
  17   <p>You should have received a copy of the GNU Library General Public
  18     License along with this library; if not, write to the
  19     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20     Boston, MA 02111-1307, USA.</p>
  21 </tp:license>
  22 <interface name="org.freedesktop.accessibility.Hypertext">
  23   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  24     <p>An interface used for objects which implement linking between
  25       multiple resource or content locations, or multiple 'markers'
  26       within a single document.  A Hypertext instance is associated with
  27       one or more Hyperlinks, which are associated with particular
  28       offsets within the Hypertext's included content.  </p>
  29
  30     <p>@note While this interface is derived from ::Text,
  31       there is no requirement that Hypertext instances have
  32       textual content; they may implement ::Image as well,
  33       and Hyperlinks need not have non-zero text offsets.</p>
  34   </tp:docstring>
  35   <method name="getNLinks">
  36     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  37       <p>Query the hypertext object for the number of Hyperlinks it
  38         contains.    </p>
  39     </tp:docstring>
  40     <arg direction="out" type="i">
  41     <tp:docstring>
  42       the number of Hyperlinks associated with this Hypertextobject, as a long integer.
  43     </tp:docstring>
  44     </arg>
  45   </method>
  46   <method name="getLink">
  47     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  48       <p>Get one of the Hyperlinks associated with this Hypertext object,
  49         by index.    </p>
  50
  51       <p>@param linkIndex an integer from 0 to getNLinks() - 1.</p>
  52     </tp:docstring>
  53     <arg direction="in" name="linkIndex" type="i"/>
  54     <arg direction="out" type="o" tp:type="Hyperlink">
  55     <tp:docstring>
  56       the Hyperlink in this Hypertext object.
  57     </tp:docstring>
  58     </arg>
  59   </method>
  60   <method name="getLinkIndex">
  61     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  62       <p>Get the hyperlink index, if any, associated with a
  63         particular character offset in the Hypertext object.
  64         For Hypertext implementors without textual content, all
  65         hyperlinks are associated with character offset '0'.    </p>
  66
  67       <p>@return the index of the Hyperlink associated with character
  68         offset \c characterIndex, or -1 if no Hyperlink is associated
  69         with that character offset.</p>
  70     </tp:docstring>
  71     <arg direction="in" name="characterIndex" type="i"/>
  72     <arg direction="out" type="i"/>
  73   </method>
  74   <method name="unImplemented">
  75     <tp:docstring>
  76       \cond
  77     </tp:docstring>
  78   </method>
  79   <method name="unImplemented2">
  80   </method>
  81   <method name="unImplemented3">
  82   </method>
  83   <method name="unImplemented4">
  84   </method>
  85 </interface>
  86 </node>