This file is indexed.

/usr/share/gtk-doc/html/at-spi-cspi/at-spi-cspi-AccessibleHyperlink-Interface.html is in at-spi-doc 1.32.0-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AccessibleHyperlink Interface</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="AT-SPI C Bindings Reference Manual">
<link rel="up" href="ch05.html" title="Auxiliary Types">
<link rel="prev" href="ch05.html" title="Auxiliary Types">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch05.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">AT-SPI C Bindings Reference Manual</th>
<td> </td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#at-spi-cspi-AccessibleHyperlink-Interface.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#at-spi-cspi-AccessibleHyperlink-Interface.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="at-spi-cspi-AccessibleHyperlink-Interface"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="at-spi-cspi-AccessibleHyperlink-Interface.top_of_page"></a>AccessibleHyperlink Interface</span></h2>
<p>AccessibleHyperlink Interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="at-spi-cspi-AccessibleHyperlink-Interface.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">void</span>                <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-ref" title="AccessibleHyperlink_ref ()">AccessibleHyperlink_ref</a>             (<em class="parameter"><code><span class="type">AccessibleHyperlink</span> *obj</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-unref" title="AccessibleHyperlink_unref ()">AccessibleHyperlink_unref</a>           (<em class="parameter"><code><span class="type">AccessibleHyperlink</span> *obj</code></em>);
<span class="returnvalue">long</span>                <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getNAnchors" title="AccessibleHyperlink_getNAnchors ()">AccessibleHyperlink_getNAnchors</a>     (<em class="parameter"><code><span class="type">AccessibleHyperlink</span> *obj</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getIndexRange" title="AccessibleHyperlink_getIndexRange ()">AccessibleHyperlink_getIndexRange</a>   (<em class="parameter"><code><span class="type">AccessibleHyperlink</span> *obj</code></em>,
                                                         <em class="parameter"><code>long <span class="type">int</span> *startIndex</code></em>,
                                                         <em class="parameter"><code>long <span class="type">int</span> *endIndex</code></em>);
<a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="returnvalue">Accessible</span></a> *        <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getObject" title="AccessibleHyperlink_getObject ()">AccessibleHyperlink_getObject</a>       (<em class="parameter"><code><span class="type">AccessibleHyperlink</span> *obj</code></em>,
                                                         <em class="parameter"><code>long <span class="type">int</span> i</code></em>);
<span class="returnvalue">char</span> *              <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getURI" title="AccessibleHyperlink_getURI ()">AccessibleHyperlink_getURI</a>          (<em class="parameter"><code><span class="type">AccessibleHyperlink</span> *obj</code></em>,
                                                         <em class="parameter"><code>long <span class="type">int</span> i</code></em>);
<span class="returnvalue">SPIBoolean</span>          <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-isValid" title="AccessibleHyperlink_isValid ()">AccessibleHyperlink_isValid</a>         (<em class="parameter"><code><span class="type">AccessibleHyperlink</span> *obj</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="at-spi-cspi-AccessibleHyperlink-Interface.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="at-spi-cspi-AccessibleHyperlink-Interface.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AccessibleHyperlink-ref"></a><h3>AccessibleHyperlink_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                AccessibleHyperlink_ref             (<em class="parameter"><code><span class="type">AccessibleHyperlink</span> *obj</code></em>);</pre>
<p>
Increment the reference count for an <span class="type">AccessibleHyperlink</span> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleHyperlink</span> object on which to operate.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleHyperlink-unref"></a><h3>AccessibleHyperlink_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                AccessibleHyperlink_unref           (<em class="parameter"><code><span class="type">AccessibleHyperlink</span> *obj</code></em>);</pre>
<p>
Decrement the reference count for an <span class="type">AccessibleHyperlink</span> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleHyperlink</span> object on which to operate.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleHyperlink-getNAnchors"></a><h3>AccessibleHyperlink_getNAnchors ()</h3>
<pre class="programlisting"><span class="returnvalue">long</span>                AccessibleHyperlink_getNAnchors     (<em class="parameter"><code><span class="type">AccessibleHyperlink</span> *obj</code></em>);</pre>
<p>
Get the total number of anchors which an <span class="type">AccessibleHyperlink</span> implementor has.
      Though typical hyperlinks have only one anchor, client-side image maps and
      other hypertext objects may potentially activate or refer to multiple
      URIs.  For each anchor there is a corresponding URI and object.
<em class="parameter"><code>see</code></em> <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getURI" title="AccessibleHyperlink_getURI ()"><code class="function">AccessibleHyperlink_getURI()</code></a> and <a class="link" href="at-spi-cspi-AccessibleHyperlink-Interface.html#AccessibleHyperlink-getObject" title="AccessibleHyperlink_getObject ()"><code class="function">AccessibleHyperlink_getObject()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleHyperlink</span> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">long</span> indicating the number of anchors in this hyperlink.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleHyperlink-getIndexRange"></a><h3>AccessibleHyperlink_getIndexRange ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                AccessibleHyperlink_getIndexRange   (<em class="parameter"><code><span class="type">AccessibleHyperlink</span> *obj</code></em>,
                                                         <em class="parameter"><code>long <span class="type">int</span> *startIndex</code></em>,
                                                         <em class="parameter"><code>long <span class="type">int</span> *endIndex</code></em>);</pre>
<p>
Get the starting and ending character offsets of the text range associated with
      a <span class="type">AccessibleHyperlink</span>, in its originating <span class="type">AccessibleHypertext</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleHyperlink</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>startIndex</code></em> :</span></p></td>
<td>a pointer to a long integer into which the starting
offset of the text associated with this <span class="type">AccessibleHyperlink</span> is returned.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>endIndex</code></em> :</span></p></td>
<td>a pointer to a long integer into which the offset of the first character
after the text associated with this <span class="type">AccessibleHyperlink</span> is returned.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleHyperlink-getObject"></a><h3>AccessibleHyperlink_getObject ()</h3>
<pre class="programlisting"><a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="returnvalue">Accessible</span></a> *        AccessibleHyperlink_getObject       (<em class="parameter"><code><span class="type">AccessibleHyperlink</span> *obj</code></em>,
                                                         <em class="parameter"><code>long <span class="type">int</span> i</code></em>);</pre>
<p>
Get the object associated with a particular hyperlink anchor, as an <a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleHyperlink</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>a (zero-index) long integer indicating which hyperlink anchor to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> that represents the object associated with the <em class="parameter"><code>ith</code></em> anchor
of the specified <span class="type">AccessibleHyperlink</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleHyperlink-getURI"></a><h3>AccessibleHyperlink_getURI ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *              AccessibleHyperlink_getURI          (<em class="parameter"><code><span class="type">AccessibleHyperlink</span> *obj</code></em>,
                                                         <em class="parameter"><code>long <span class="type">int</span> i</code></em>);</pre>
<p>
Get the URI associated with a particular hyperlink anchor.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleHyperlink</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>a (zero-index) long integer indicating which hyperlink anchor to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a UTF-8 string giving the URI of the <em class="parameter"><code>ith</code></em> hyperlink anchor.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleHyperlink-isValid"></a><h3>AccessibleHyperlink_isValid ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span>          AccessibleHyperlink_isValid         (<em class="parameter"><code><span class="type">AccessibleHyperlink</span> *obj</code></em>);</pre>
<p>
Tell whether an <span class="type">AccessibleHyperlink</span> object is still valid with respect to its
         originating hypertext object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleHyperlink</span> on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> of the specified <span class="type">AccessibleHyperlink</span> is still valid with respect
to its originating <span class="type">AccessibleHypertext</span> object, <span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>