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