This file is indexed.

/usr/share/gtk-doc/html/libatspi/libatspi-atspi-hypertext.html is in at-spi2-doc 2.4.0-1.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>atspi-hypertext</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libatspi Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="AtspiEventListener.html" title="atspi-event-listener">
<link rel="next" href="libatspi-atspi-component.html" title="atspi-component">
<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="AtspiEventListener.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">libatspi Reference Manual</th>
<td><a accesskey="n" href="libatspi-atspi-component.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libatspi-atspi-hypertext.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libatspi-atspi-hypertext.description" class="shortcut">Description</a>
                   | 
                  <a href="#libatspi-atspi-hypertext.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#libatspi-atspi-hypertext.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="libatspi-atspi-hypertext"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-hypertext.top_of_page"></a>atspi-hypertext</span></h2>
<p>atspi-hypertext — An interface used for objects which implement linking between
multiple resource locations.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libatspi-atspi-hypertext.synopsis"></a><h2>Synopsis</h2>
<a name="AtspiHypertext"></a><pre class="synopsis">                    <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext-struct" title="AtspiHypertext">AtspiHypertext</a>;
<span class="returnvalue">gint</span>                <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>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<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>,
                                                         <em class="parameter"><code><span class="type">gint</span> link_index</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gint</span>                <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>,
                                                         <em class="parameter"><code><span class="type">gint</span> character_offset</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-hypertext.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GInterface
   +----AtspiHypertext
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-hypertext.implementations"></a><h2>Known Implementations</h2>
<p>
AtspiHypertext is implemented by
 <a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-hypertext.description"></a><h2>Description</h2>
<p>
An interface used for objects which implement linking between
multiple resource or content locations, or multiple 'markers'
within a single document. A hypertext instance is associated
with one or more hyperlinks which are associated with	particular
offests within the hypertext's content.
</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-hypertext.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtspiHypertext-struct"></a><h3>AtspiHypertext</h3>
<pre class="programlisting">typedef struct _AtspiHypertext AtspiHypertext;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-hypertext-get-n-links"></a><h3>atspi_hypertext_get_n_links ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>                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>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the total number of <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> objects that an
<a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> implementor has.
</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 <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> implementor 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">gint</span> indicating the number of <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> objects
of the <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> implementor, or -1 if
the number cannot be determined (for example, if the
<a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> object is so large that it is not
all currently in the memory cache).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-hypertext-get-link"></a><h3>atspi_hypertext_get_link ()</h3>
<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>,
                                                         <em class="parameter"><code><span class="type">gint</span> link_index</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> object at a specified index.
</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 <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>link_index</code></em> :</span></p></td>
<td>a (zero-index) <span class="type">gint</span> indicating which hyperlink to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> object specified by
<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>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-hypertext-get-link-index"></a><h3>atspi_hypertext_get_link_index ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>                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>,
                                                         <em class="parameter"><code><span class="type">gint</span> character_offset</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the index of the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> object at a specified
       character offset.
</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 <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>character_offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> specifying the character offset to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the linkIndex of the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> active at
character offset <em class="parameter"><code>character_offset</code></em>, or -1 if there is
no hyperlink at the specified character offset.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>