doc/libatspi/html/libatspi-atspi-hypertext.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>atspi-hypertext</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
   7 <link rel="home" href="index.html" title="libatspi Reference Manual">
   8 <link rel="up" href="ch01.html" title="API reference">
   9 <link rel="prev" href="AtspiEventListener.html" title="atspi-event-listener">
  10 <link rel="next" href="libatspi-atspi-component.html" title="atspi-component">
  11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="AtspiEventListener.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">libatspi Reference Manual</th>
  21 <td><a accesskey="n" href="libatspi-atspi-component.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#libatspi-atspi-hypertext.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libatspi-atspi-hypertext.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#libatspi-atspi-hypertext.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#libatspi-atspi-hypertext.implementations" class="shortcut">Known Implementations</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="libatspi-atspi-hypertext"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="libatspi-atspi-hypertext.top_of_page"></a>atspi-hypertext</span></h2>
  38 <p>atspi-hypertext — An interface used for objects which implement linking between
  39 multiple resource locations.</p>
  40 </td>
  41 <td valign="top" align="right"></td>
  42 </tr></table></div>
  43 <div class="refsynopsisdiv">
  44 <a name="libatspi-atspi-hypertext.synopsis"></a><h2>Synopsis</h2>
  45 <a name="AtspiHypertext"></a><pre class="synopsis">                    <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext-struct" title="AtspiHypertext">AtspiHypertext</a>;
  46 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="libatspi-atspi-hypertext.html#atspi-hypertext-get-n-links" title="atspi_hypertext_get_n_links ()">atspi_hypertext_get_n_links</a>         (<em class="parameter"><code><a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> *obj</code></em>,
  47                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  48 <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="returnvalue">AtspiHyperlink</span></a> *    <a class="link" href="libatspi-atspi-hypertext.html#atspi-hypertext-get-link" title="atspi_hypertext_get_link ()">atspi_hypertext_get_link</a>            (<em class="parameter"><code><a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> *obj</code></em>,
  49                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> link_index</code></em>,
  50                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  51 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="libatspi-atspi-hypertext.html#atspi-hypertext-get-link-index" title="atspi_hypertext_get_link_index ()">atspi_hypertext_get_link_index</a>      (<em class="parameter"><code><a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> *obj</code></em>,
  52                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> character_offset</code></em>,
  53                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="libatspi-atspi-hypertext.object-hierarchy"></a><h2>Object Hierarchy</h2>
  58 <pre class="synopsis">
  59   GInterface
  60    +----AtspiHypertext
  61 </pre>
  62 </div>
  63 <div class="refsect1">
  64 <a name="libatspi-atspi-hypertext.implementations"></a><h2>Known Implementations</h2>
  65 <p>
  66 AtspiHypertext is implemented by
  67  <a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
  68 </div>
  69 <div class="refsect1">
  70 <a name="libatspi-atspi-hypertext.description"></a><h2>Description</h2>
  71 <p>
  72 An interface used for objects which implement linking between
  73 multiple resource or content locations, or multiple 'markers'
  74 within a single document. A hypertext instance is associated
  75 with one or more hyperlinks which are associated with   particular
  76 offests within the hypertext's content.
  77 </p>
  78 </div>
  79 <div class="refsect1">
  80 <a name="libatspi-atspi-hypertext.details"></a><h2>Details</h2>
  81 <div class="refsect2">
  82 <a name="AtspiHypertext-struct"></a><h3>AtspiHypertext</h3>
  83 <pre class="programlisting">typedef struct _AtspiHypertext AtspiHypertext;</pre>
  84 <p>
  85 </p>
  86 </div>
  87 <hr>
  88 <div class="refsect2">
  89 <a name="atspi-hypertext-get-n-links"></a><h3>atspi_hypertext_get_n_links ()</h3>
  90 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                atspi_hypertext_get_n_links         (<em class="parameter"><code><a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> *obj</code></em>,
  91                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
  92 <p>
  93 Gets the total number of <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> objects that an
  94 <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> implementor has.
  95 </p>
  96 <div class="variablelist"><table border="0" class="variablelist">
  97 <colgroup>
  98 <col align="left" valign="top">
  99 <col>
 100 </colgroup>
 101 <tbody>
 102 <tr>
 103 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 104 <td>a pointer to the <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> implementor on which to operate.</td>
 105 </tr>
 106 <tr>
 107 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 108 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the number of <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> objects
 109 of the <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> implementor, or -1 if
 110 the number cannot be determined (for example, if the
 111 <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> object is so large that it is not
 112 all currently in the memory cache).</td>
 113 </tr>
 114 </tbody>
 115 </table></div>
 116 </div>
 117 <hr>
 118 <div class="refsect2">
 119 <a name="atspi-hypertext-get-link"></a><h3>atspi_hypertext_get_link ()</h3>
 120 <pre class="programlisting"><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="returnvalue">AtspiHyperlink</span></a> *    atspi_hypertext_get_link            (<em class="parameter"><code><a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> *obj</code></em>,
 121                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> link_index</code></em>,
 122                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 123 <p>
 124 Gets the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> object at a specified index.
 125 </p>
 126 <div class="variablelist"><table border="0" class="variablelist">
 127 <colgroup>
 128 <col align="left" valign="top">
 129 <col>
 130 </colgroup>
 131 <tbody>
 132 <tr>
 133 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 134 <td>a pointer to the <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> implementor on which to operate.</td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term"><em class="parameter"><code>link_index</code></em> :</span></p></td>
 138 <td>a (zero-index) <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating which hyperlink to query.</td>
 139 </tr>
 140 <tr>
 141 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 142 <td>the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> object specified by
 143 <em class="parameter"><code>link_index</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 144 </td>
 145 </tr>
 146 </tbody>
 147 </table></div>
 148 </div>
 149 <hr>
 150 <div class="refsect2">
 151 <a name="atspi-hypertext-get-link-index"></a><h3>atspi_hypertext_get_link_index ()</h3>
 152 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                atspi_hypertext_get_link_index      (<em class="parameter"><code><a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> *obj</code></em>,
 153                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> character_offset</code></em>,
 154                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 155 <p>
 156 Gets the index of the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> object at a specified
 157        character offset.
 158 </p>
 159 <div class="variablelist"><table border="0" class="variablelist">
 160 <colgroup>
 161 <col align="left" valign="top">
 162 <col>
 163 </colgroup>
 164 <tbody>
 165 <tr>
 166 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 167 <td>a pointer to the <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> implementor on which to operate.</td>
 168 </tr>
 169 <tr>
 170 <td><p><span class="term"><em class="parameter"><code>character_offset</code></em> :</span></p></td>
 171 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> specifying the character offset to query.</td>
 172 </tr>
 173 <tr>
 174 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 175 <td>the linkIndex of the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> active at
 176 character offset <em class="parameter"><code>character_offset</code></em>, or -1 if there is
 177 no hyperlink at the specified character offset.</td>
 178 </tr>
 179 </tbody>
 180 </table></div>
 181 </div>
 182 </div>
 183 </div>
 184 <div class="footer">
 185 <hr>
 186           Generated by GTK-Doc V1.18.1</div>
 187 </body>
 188 </html>