This file is indexed.

/usr/share/gtk-doc/html/libatspi/libatspi-atspi-value.html is in at-spi2-doc 2.10.2.is.2.10.1-0ubuntu1.

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
227
228
<!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-value</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libatspi Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="libatspi-atspi-editabletext.html" title="atspi-editabletext">
<link rel="next" href="libatspi-atspi-table.html" title="atspi-table">
<meta name="generator" content="GTK-Doc V1.19 (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="libatspi-atspi-editabletext.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-table.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-value.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libatspi-atspi-value.description" class="shortcut">Description</a>
                   | 
                  <a href="#libatspi-atspi-value.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#libatspi-atspi-value.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="libatspi-atspi-value"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-value.top_of_page"></a>atspi-value</span></h2>
<p>atspi-value — An interface supporting a one-dimensional scalar
to be modified, or which reflects its value.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libatspi-atspi-value.synopsis"></a><h2>Synopsis</h2>
<a name="AtspiValue"></a><pre class="synopsis">                    <a class="link" href="libatspi-atspi-value.html#AtspiValue-struct" title="AtspiValue">AtspiValue</a>;
<span class="returnvalue">gdouble</span>             <a class="link" href="libatspi-atspi-value.html#atspi-value-get-minimum-value" title="atspi_value_get_minimum_value ()">atspi_value_get_minimum_value</a>       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gdouble</span>             <a class="link" href="libatspi-atspi-value.html#atspi-value-get-current-value" title="atspi_value_get_current_value ()">atspi_value_get_current_value</a>       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gdouble</span>             <a class="link" href="libatspi-atspi-value.html#atspi-value-get-maximum-value" title="atspi_value_get_maximum_value ()">atspi_value_get_maximum_value</a>       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="libatspi-atspi-value.html#atspi-value-set-current-value" title="atspi_value_set_current_value ()">atspi_value_set_current_value</a>       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gdouble</span> new_value</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gdouble</span>             <a class="link" href="libatspi-atspi-value.html#atspi-value-get-minimum-increment" title="atspi_value_get_minimum_increment ()">atspi_value_get_minimum_increment</a>   (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-value.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GInterface
   +----AtspiValue
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-value.implementations"></a><h2>Known Implementations</h2>
<p>
AtspiValue is implemented by
 <a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-value.description"></a><h2>Description</h2>
<p>
An interface supporting a one-dimensional scalar
to be modified, or which reflects its value. If
STATE_EDITABLE is not present, the value is
treated as "read only".
</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-value.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtspiValue-struct"></a><h3>AtspiValue</h3>
<pre class="programlisting">typedef struct _AtspiValue AtspiValue;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-value-get-minimum-value"></a><h3>atspi_value_get_minimum_value ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>             atspi_value_get_minimum_value       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the minimum allowed value for an <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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-value.html#AtspiValue"><span class="type">AtspiValue</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>the minimum allowed value for this object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-value-get-current-value"></a><h3>atspi_value_get_current_value ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>             atspi_value_get_current_value       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the current value for an <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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-value.html#AtspiValue"><span class="type">AtspiValue</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>the current value for this object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-value-get-maximum-value"></a><h3>atspi_value_get_maximum_value ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>             atspi_value_get_maximum_value       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the maximum allowed value for an <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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-value.html#AtspiValue"><span class="type">AtspiValue</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>the maximum allowed value for this object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-value-set-current-value"></a><h3>atspi_value_set_current_value ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            atspi_value_set_current_value       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gdouble</span> new_value</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Sets the current value of an <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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-value.html#AtspiValue"><span class="type">AtspiValue</span></a> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_value</code></em> :</span></p></td>
<td>a <span class="type">gdouble</span> value which is the desired new value of the object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if the value could be assigned the specified value,
<span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-value-get-minimum-increment"></a><h3>atspi_value_get_minimum_increment ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>             atspi_value_get_minimum_increment   (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the minimum increment by which an <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> can be adjusted.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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-value.html#AtspiValue"><span class="type">AtspiValue</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>the minimum increment by which the value may be changed, or
zero if the minimum increment cannot be determined.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>