doc/libatspi/html/AtspiHyperlink.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-hyperlink</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="AtspiDeviceListener.html" title="atspi-devicelistener">
  10 <link rel="next" href="libatspi-atspi-editabletext.html" title="atspi-editabletext">
  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="AtspiDeviceListener.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-editabletext.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="#AtspiHyperlink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#AtspiHyperlink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#AtspiHyperlink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="AtspiHyperlink"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="AtspiHyperlink.top_of_page"></a>atspi-hyperlink</span></h2>
  36 <p>atspi-hyperlink — Instances of atspi-hyperlink are the means by which end users
  37 and clients interact with linked content.</p>
  38 </td>
  39 <td valign="top" align="right"></td>
  40 </tr></table></div>
  41 <div class="refsynopsisdiv">
  42 <a name="AtspiHyperlink.synopsis"></a><h2>Synopsis</h2>
  43 <pre class="synopsis">                    <a class="link" href="AtspiHyperlink.html#AtspiHyperlink-struct" title="AtspiHyperlink">AtspiHyperlink</a>;
  44 struct              <a class="link" href="AtspiHyperlink.html#AtspiHyperlinkClass" title="struct AtspiHyperlinkClass">AtspiHyperlinkClass</a>;
  45 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-n-anchors" title="atspi_hyperlink_get_n_anchors ()">atspi_hyperlink_get_n_anchors</a>       (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
  46                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  47 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-uri" title="atspi_hyperlink_get_uri ()">atspi_hyperlink_get_uri</a>             (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
  48                                                          <em class="parameter"><code><span class="type">int</span> i</code></em>,
  49                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  50 <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *   <a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-object" title="atspi_hyperlink_get_object ()">atspi_hyperlink_get_object</a>          (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
  51                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>,
  52                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  53 <a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="returnvalue">AtspiRange</span></a> *        <a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-index-range" title="atspi_hyperlink_get_index_range ()">atspi_hyperlink_get_index_range</a>     (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
  54                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  55 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-start-index" title="atspi_hyperlink_get_start_index ()">atspi_hyperlink_get_start_index</a>     (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
  56                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  57 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-end-index" title="atspi_hyperlink_get_end_index ()">atspi_hyperlink_get_end_index</a>       (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
  58                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  59 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="AtspiHyperlink.html#atspi-hyperlink-is-valid" title="atspi_hyperlink_is_valid ()">atspi_hyperlink_is_valid</a>            (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
  60                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  61 </pre>
  62 </div>
  63 <div class="refsect1">
  64 <a name="AtspiHyperlink.object-hierarchy"></a><h2>Object Hierarchy</h2>
  65 <pre class="synopsis">
  66   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  67    +----<a class="link" href="AtspiObject.html" title="AtspiObject">AtspiObject</a>
  68          +----AtspiHyperlink
  69 </pre>
  70 </div>
  71 <div class="refsect1">
  72 <a name="AtspiHyperlink.description"></a><h2>Description</h2>
  73 <p>
  74  Instances of atspi-hyperlink are returned by
  75  atspi-hypertext objects, and are the means by
  76  which end users and clients interact with linked,
  77  and in some cases embedded, content. These instances
  78  may have multiple "anchors", where an anchor corresponds to a
  79  reference to a particular resource with a corresponding resource
  80  identified (URI).
  81 </p>
  82 </div>
  83 <div class="refsect1">
  84 <a name="AtspiHyperlink.details"></a><h2>Details</h2>
  85 <div class="refsect2">
  86 <a name="AtspiHyperlink-struct"></a><h3>AtspiHyperlink</h3>
  87 <pre class="programlisting">typedef struct _AtspiHyperlink AtspiHyperlink;</pre>
  88 <p>
  89 </p>
  90 </div>
  91 <hr>
  92 <div class="refsect2">
  93 <a name="AtspiHyperlinkClass"></a><h3>struct AtspiHyperlinkClass</h3>
  94 <pre class="programlisting">struct AtspiHyperlinkClass {
  95   AtspiObjectClass parent_class;
  96 };
  97 </pre>
  98 <p>
  99 </p>
 100 </div>
 101 <hr>
 102 <div class="refsect2">
 103 <a name="atspi-hyperlink-get-n-anchors"></a><h3>atspi_hyperlink_get_n_anchors ()</h3>
 104 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                atspi_hyperlink_get_n_anchors       (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
 105                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 106 <p>
 107 Gets the total number of anchors which an <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> implementor has.
 108 Though typical hyperlinks have only one anchor, client-side image maps and
 109 other hypertext objects may potentially activate or refer to multiple
 110 URIs.  For each anchor there is a corresponding URI and object.
 111 </p>
 112 <p>
 113 see: <a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-uri" title="atspi_hyperlink_get_uri ()"><span class="type">atspi_hyperlink_get_uri</span></a> and <a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-object" title="atspi_hyperlink_get_object ()"><span class="type">atspi_hyperlink_get_object</span></a>.
 114 </p>
 115 <div class="variablelist"><table border="0" class="variablelist">
 116 <colgroup>
 117 <col align="left" valign="top">
 118 <col>
 119 </colgroup>
 120 <tbody>
 121 <tr>
 122 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 123 <td>a pointer to the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> object on which to operate.</td>
 124 </tr>
 125 <tr>
 126 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 127 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the number of anchors in this hyperlink.</td>
 128 </tr>
 129 </tbody>
 130 </table></div>
 131 </div>
 132 <hr>
 133 <div class="refsect2">
 134 <a name="atspi-hyperlink-get-uri"></a><h3>atspi_hyperlink_get_uri ()</h3>
 135 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             atspi_hyperlink_get_uri             (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
 136                                                          <em class="parameter"><code><span class="type">int</span> i</code></em>,
 137                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 138 <p>
 139 Gets the URI associated with a particular hyperlink anchor.
 140 </p>
 141 <div class="variablelist"><table border="0" class="variablelist">
 142 <colgroup>
 143 <col align="left" valign="top">
 144 <col>
 145 </colgroup>
 146 <tbody>
 147 <tr>
 148 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 149 <td>a pointer to the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> implementor on which to operate.</td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
 153 <td>a (zero-index) integer indicating which hyperlink anchor to query.</td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 157 <td>a UTF-8 string giving the URI of the <em class="parameter"><code>ith</code></em> hyperlink anchor.</td>
 158 </tr>
 159 </tbody>
 160 </table></div>
 161 </div>
 162 <hr>
 163 <div class="refsect2">
 164 <a name="atspi-hyperlink-get-object"></a><h3>atspi_hyperlink_get_object ()</h3>
 165 <pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *   atspi_hyperlink_get_object          (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
 166                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>,
 167                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 168 <p>
 169 Gets the object associated with a particular hyperlink anchor, as an
 170 <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.
 171 </p>
 172 <div class="variablelist"><table border="0" class="variablelist">
 173 <colgroup>
 174 <col align="left" valign="top">
 175 <col>
 176 </colgroup>
 177 <tbody>
 178 <tr>
 179 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 180 <td>a pointer to the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> implementor on which to operate.</td>
 181 </tr>
 182 <tr>
 183 <td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
 184 <td>a (zero-index) <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating which hyperlink anchor to query.</td>
 185 </tr>
 186 <tr>
 187 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 188 <td>an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> that represents the object
 189 associated with the <em class="parameter"><code>ith</code></em> anchor of the specified <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 190 </td>
 191 </tr>
 192 </tbody>
 193 </table></div>
 194 </div>
 195 <hr>
 196 <div class="refsect2">
 197 <a name="atspi-hyperlink-get-index-range"></a><h3>atspi_hyperlink_get_index_range ()</h3>
 198 <pre class="programlisting"><a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="returnvalue">AtspiRange</span></a> *        atspi_hyperlink_get_index_range     (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
 199                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 200 <p>
 201 Gets the starting and ending character offsets of the text range
 202 associated with an <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a>, in its originating <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a>.
 203 </p>
 204 <div class="variablelist"><table border="0" class="variablelist">
 205 <colgroup>
 206 <col align="left" valign="top">
 207 <col>
 208 </colgroup>
 209 <tbody><tr>
 210 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 211 <td>a pointer to the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> implementor on which to operate.</td>
 212 </tr></tbody>
 213 </table></div>
 214 </div>
 215 <hr>
 216 <div class="refsect2">
 217 <a name="atspi-hyperlink-get-start-index"></a><h3>atspi_hyperlink_get_start_index ()</h3>
 218 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                atspi_hyperlink_get_start_index     (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
 219                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 220 <p>
 221 Gets the starting character offset of the text range associated with
 222       an <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a>, in its originating <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a>.
 223 </p>
 224 <div class="variablelist"><table border="0" class="variablelist">
 225 <colgroup>
 226 <col align="left" valign="top">
 227 <col>
 228 </colgroup>
 229 <tbody><tr>
 230 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 231 <td>a pointer to the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> implementor on which to operate.</td>
 232 </tr></tbody>
 233 </table></div>
 234 </div>
 235 <hr>
 236 <div class="refsect2">
 237 <a name="atspi-hyperlink-get-end-index"></a><h3>atspi_hyperlink_get_end_index ()</h3>
 238 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                atspi_hyperlink_get_end_index       (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
 239                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 240 <p>
 241 Gets the ending character offset of the text range associated with
 242       an <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a>, in its originating <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a>.
 243 </p>
 244 <div class="variablelist"><table border="0" class="variablelist">
 245 <colgroup>
 246 <col align="left" valign="top">
 247 <col>
 248 </colgroup>
 249 <tbody><tr>
 250 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 251 <td>a pointer to the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> implementor on which to operate.</td>
 252 </tr></tbody>
 253 </table></div>
 254 </div>
 255 <hr>
 256 <div class="refsect2">
 257 <a name="atspi-hyperlink-is-valid"></a><h3>atspi_hyperlink_is_valid ()</h3>
 258 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atspi_hyperlink_is_valid            (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
 259                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 260 <p>
 261 Tells whether an <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> object is still valid with respect to its
 262          originating hypertext object.
 263 </p>
 264 <div class="variablelist"><table border="0" class="variablelist">
 265 <colgroup>
 266 <col align="left" valign="top">
 267 <col>
 268 </colgroup>
 269 <tbody>
 270 <tr>
 271 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 272 <td>a pointer to the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> on which to operate.</td>
 273 </tr>
 274 <tr>
 275 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 276 <td>
 277 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if the specified <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> is still valid with respect
 278 to its originating <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> object, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.</td>
 279 </tr>
 280 </tbody>
 281 </table></div>
 282 </div>
 283 </div>
 284 </div>
 285 <div class="footer">
 286 <hr>
 287           Generated by GTK-Doc V1.18.1</div>
 288 </body>
 289 </html>