xml/org.freedesktop.atspi.Hypertext.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
   3 <interface name="org.freedesktop.atspi.Hypertext">
   4   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
   5     <p>An interface used for objects which implement linking between
   6       multiple resource or content locations, or multiple 'markers'
   7       within a single document.  A Hypertext instance is associated with
   8       one or more Hyperlinks, which are associated with particular
   9       offsets within the Hypertext's included content.  </p>
  10
  11     <p>While this interface is derived from Text,
  12       there is no requirement that Hypertext instances have
  13       textual content; they may implement Image as well,
  14       and Hyperlinks need not have non-zero text offsets.</p>
  15   </tp:docstring>
  16   <method name="getNLinks">
  17     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  18       <p>Query the hypertext object for the number of Hyperlinks it
  19         contains.</p>
  20     </tp:docstring>
  21     <arg direction="out" type="i">
  22     <tp:docstring>
  23       The number of Hyperlinks associated with this Hypertextobject, as a long integer.
  24     </tp:docstring>
  25     </arg>
  26   </method>
  27   <method name="getLink">
  28     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  29       <p>Get one of the Hyperlinks associated with this Hypertext object,
  30         by index.</p>
  31     </tp:docstring>
  32     <arg direction="in" name="linkIndex" type="i">
  33             <tp:docstring>
  34                 <p>An integer from 0 to getNLinks() - 1.</p>
  35             </tp:docstring>
  36     </arg>
  37     <arg direction="out" type="o" tp:type="Hyperlink">
  38     <tp:docstring>
  39       The Hyperlink in this Hypertext object.
  40     </tp:docstring>
  41     </arg>
  42   </method>
  43   <method name="getLinkIndex">
  44     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  45       <p>Get the hyperlink index, if any, associated with a
  46         particular character offset in the Hypertext object.
  47         For Hypertext implementors without textual content, all
  48         hyperlinks are associated with character offset '0'.    </p>
  49
  50     </tp:docstring>
  51     <arg direction="in" name="characterIndex" type="i"/>
  52     <arg direction="out" type="i">
  53       <tp:docstring>
  54         <p>The index of the Hyperlink associated with character
  55            offset <code>characterIndex</code>, or -1 if no Hyperlink is associated
  56            with that character offset.
  57         </p>
  58       </tp:docstring>
  59     </arg>
  60   </method>
  61 </interface>
  62 </node>