This file is indexed.

/usr/share/gtk-doc/html/libatspi/libatspi-atspi-action.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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
<!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-action</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-collection.html" title="atspi-collection">
<link rel="next" href="AtspiRelation.html" title="atspi-relation">
<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-collection.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="AtspiRelation.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-action.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libatspi-atspi-action.description" class="shortcut">Description</a>
                   | 
                  <a href="#libatspi-atspi-action.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#libatspi-atspi-action.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="libatspi-atspi-action"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-action.top_of_page"></a>atspi-action</span></h2>
<p>atspi-action</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libatspi-atspi-action.synopsis"></a><h2>Synopsis</h2>
<a name="AtspiAction"></a><pre class="synopsis">                    <a class="link" href="libatspi-atspi-action.html#AtspiAction-struct" title="AtspiAction">AtspiAction</a>;
<span class="returnvalue">gint</span>                <a class="link" href="libatspi-atspi-action.html#atspi-action-get-n-actions" title="atspi_action_get_n_actions ()">atspi_action_get_n_actions</a>          (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gchar</span> *             <a class="link" href="libatspi-atspi-action.html#atspi-action-get-description" title="atspi_action_get_description ()">atspi_action_get_description</a>        (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gchar</span> *             <a class="link" href="libatspi-atspi-action.html#atspi-action-get-key-binding" title="atspi_action_get_key_binding ()">atspi_action_get_key_binding</a>        (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gchar</span> *             <a class="link" href="libatspi-atspi-action.html#atspi-action-get-name" title="atspi_action_get_name ()">atspi_action_get_name</a>               (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> i</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-action.html#atspi-action-do-action" title="atspi_action_do_action ()">atspi_action_do_action</a>              (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-action.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GInterface
   +----AtspiAction
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-action.implementations"></a><h2>Known Implementations</h2>
<p>
AtspiAction is implemented by
 <a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-action.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-action.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtspiAction-struct"></a><h3>AtspiAction</h3>
<pre class="programlisting">typedef struct _AtspiAction AtspiAction;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-action-get-n-actions"></a><h3>atspi_action_get_n_actions ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>                atspi_action_get_n_actions          (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Get the number of actions invokable on an <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> implementor.
</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-action.html#AtspiAction"><span class="type">AtspiAction</span></a> to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer indicating the number of invocable actions.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-action-get-description"></a><h3>atspi_action_get_description ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *             atspi_action_get_description        (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">atspi_action_get_description</code> has been deprecated since version 2.10 and should not be used in newly-written code. Use atspi_action_get_action_description instead.
Rename to: atspi_action_get_action_description</p>
</div>
<p>
Get the description of '<em class="parameter"><code>i</code></em>-th' action invocable on an
     object implementing <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</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-action.html#AtspiAction"><span class="type">AtspiAction</span></a> implementor to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>an integer indicating which action 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 describing the '<em class="parameter"><code>i</code></em>-th' invocable action.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-action-get-key-binding"></a><h3>atspi_action_get_key_binding ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *             atspi_action_get_key_binding        (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Get the keybindings for the <em class="parameter"><code>i</code></em>-th action invocable on an
     object implementing <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a>, if any are defined.
     The keybindings string format is as follows:
       there are multiple parts to a keybinding string (typically 3).
       They are delimited with ";".  The first is the action's
       keybinding which is usable if the object implementing the action
       is currently posted to the screen, e.g. if a menu is posted 
       then these keybindings for the corresponding menu-items are
       available.  The second keybinding substring is the full key sequence
       necessary to post the action's widget and activate it, e.g. for
       a menu item such as "File-&gt;Open" it would both post the menu and
       activate the item.  Thus the second keybinding string is available
       during the lifetime of the containing toplevel window as a whole,
       whereas the first keybinding string only works while the object
       implementing AtkAction is posted.  The third (and optional)
       keybinding string is the "keyboard shortcut" which invokes the 
       action without posting any menus. 
       Meta-keys are indicated by the conventional strings
       "&lt;Control&gt;", "&lt;Alt&gt;", "&lt;Shift&gt;", "&lt;Mod2&gt;",
       etc. (we use the same string as <code class="function">gtk_accelerator_name()</code> in 
       gtk+-2.X.
</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-action.html#AtspiAction"><span class="type">AtspiAction</span></a> implementor to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>an integer indicating which action 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 which can be parsed to determine the <em class="parameter"><code>i</code></em>-th
invocable action's keybindings.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-action-get-name"></a><h3>atspi_action_get_name ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *             atspi_action_get_name               (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">atspi_action_get_name</code> has been deprecated since version 2.10 and should not be used in newly-written code. Use atspi_action_get_action_name instead.
Rename to: atspi_action_get_action_name</p>
</div>
<p>
Get the name of the '<em class="parameter"><code>i</code></em>-th' action invocable on an
     object implementing <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</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-action.html#AtspiAction"><span class="type">AtspiAction</span></a> implementor to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>an integer indicating which action to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the non-localized name of the action, as a UTF-8 string.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-action-do-action"></a><h3>atspi_action_do_action ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            atspi_action_do_action              (<em class="parameter"><code><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Invoke the action indicated by <a class="link" href="index.html" title="libatspi Reference Manual"><span class="type">index</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-action.html#AtspiAction"><span class="type">AtspiAction</span></a> to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>an integer specifying which action to invoke.</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 action is successfully invoked, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>