← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/at-spi/intrepid-updates

« back to all changes in this revision

Viewing changes to docs/reference/cspi/html/at-spi-cspi-AccessibleApplication-API.html

  • Committer: Bazaar Package Importer
  • Author(s): Pedro Fragoso
  • Date: 2008-09-01 16:58:56 UTC
  • mfrom: (1.1.34 upstream)
  • Revision ID: james.westby@ubuntu.com-20080901165856-itp2lms1sml4a63s
Tags: 1.23.91-0ubuntu1
https://launchpad.net/bugs/263729
* New upstream release (LP: #263729)
  - Bugfixes: #548559, #350552, #547875.
  - Translation update
* debian/control.in:
  - Add B-d on intltool (>= 0.40.0)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/cspi/html/at-spi-cspi-AccessibleApplication-API.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>AccessibleApplication API</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
7
7
<link rel="start" href="index.html" title="AT-SPI C Bindings Reference Manual">
8
8
<link rel="up" href="spi-application.html" title="AccessibleApplication Methods">
9
9
<link rel="prev" href="spi-application.html" title="AccessibleApplication Methods">
42
42
<div class="refsynopsisdiv">
43
43
<a name="at-spi-cspi-AccessibleApplication-API.synopsis"></a><h2>Synopsis</h2>
44
44
<pre class="synopsis">
45
 
void                <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-ref" title="AccessibleApplication_ref ()">AccessibleApplication_ref</a>           (AccessibleApplication *obj);
46
 
void                <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-unref" title="AccessibleApplication_unref ()">AccessibleApplication_unref</a>         (AccessibleApplication *obj);
47
 
char*               <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-getToolkitName" title="AccessibleApplication_getToolkitName ()">AccessibleApplication_getToolkitName</a>
 
45
void                <a href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-ref" title="AccessibleApplication_ref ()">AccessibleApplication_ref</a>           (AccessibleApplication *obj);
 
46
void                <a href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-unref" title="AccessibleApplication_unref ()">AccessibleApplication_unref</a>         (AccessibleApplication *obj);
 
47
char*               <a href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-getToolkitName" title="AccessibleApplication_getToolkitName ()">AccessibleApplication_getToolkitName</a>
48
48
                                                        (AccessibleApplication *obj);
49
 
char*               <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-getVersion" title="AccessibleApplication_getVersion ()">AccessibleApplication_getVersion</a>    (AccessibleApplication *obj);
50
 
long                <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-getID" title="AccessibleApplication_getID ()">AccessibleApplication_getID</a>         (AccessibleApplication *obj);
51
 
char*               <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-getLocale" title="AccessibleApplication_getLocale ()">AccessibleApplication_getLocale</a>     (AccessibleApplication *obj,
 
49
char*               <a href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-getVersion" title="AccessibleApplication_getVersion ()">AccessibleApplication_getVersion</a>    (AccessibleApplication *obj);
 
50
long                <a href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-getID" title="AccessibleApplication_getID ()">AccessibleApplication_getID</a>         (AccessibleApplication *obj);
 
51
char*               <a href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-getLocale" title="AccessibleApplication_getLocale ()">AccessibleApplication_getLocale</a>     (AccessibleApplication *obj,
52
52
                                                         int lc_category);
53
 
SPIBoolean          <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-pause" title="AccessibleApplication_pause ()">AccessibleApplication_pause</a>         (AccessibleApplication *obj);
54
 
SPIBoolean          <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-resume" title="AccessibleApplication_resume ()">AccessibleApplication_resume</a>        (AccessibleApplication *obj);
 
53
SPIBoolean          <a href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-pause" title="AccessibleApplication_pause ()">AccessibleApplication_pause</a>         (AccessibleApplication *obj);
 
54
SPIBoolean          <a href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-resume" title="AccessibleApplication_resume ()">AccessibleApplication_resume</a>        (AccessibleApplication *obj);
55
55
</pre>
56
56
</div>
57
57
<div class="refsect1" lang="en">
76
76
<div class="variablelist"><table border="0">
77
77
<col align="left" valign="top">
78
78
<tbody><tr>
79
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
79
<td>
 
80
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
80
81
<td> a pointer to the <span class="type">AccessibleApplication</span> on which to operate.
81
82
</td>
82
83
</tr></tbody>
94
95
<div class="variablelist"><table border="0">
95
96
<col align="left" valign="top">
96
97
<tbody><tr>
97
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
98
<td>
 
99
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
98
100
<td> a pointer to the <span class="type">AccessibleApplication</span> object on which to operate.
99
101
</td>
100
102
</tr></tbody>
114
116
<col align="left" valign="top">
115
117
<tbody>
116
118
<tr>
117
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
119
<td>
 
120
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
118
121
<td> a pointer to the <span class="type">AccessibleApplication</span> to query.
119
122
</td>
120
123
</tr>
121
124
<tr>
122
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
125
<td>
 
126
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
123
127
<td> a UTF-8 string indicating which UI toolkit is
124
128
         used by an application.
125
129
</td>
141
145
<col align="left" valign="top">
142
146
<tbody>
143
147
<tr>
144
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
148
<td>
 
149
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
145
150
<td> a pointer to the <span class="type">AccessibleApplication</span> being queried.
146
151
</td>
147
152
</tr>
148
153
<tr>
149
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
154
<td>
 
155
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
150
156
<td> a UTF-8 string indicating the application's
151
157
         at-spi version.
152
158
</td>
169
175
<col align="left" valign="top">
170
176
<tbody>
171
177
<tr>
172
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
178
<td>
 
179
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
173
180
<td> a pointer to the <span class="type">AccessibleApplication</span> being queried.
174
181
</td>
175
182
</tr>
176
183
<tr>
177
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
184
<td>
 
185
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
178
186
<td> a unique <span class="type">long</span> integer associated with the application
179
187
         by the Registry, or 0 if the application is not registered.
180
188
</td>
200
208
<col align="left" valign="top">
201
209
<tbody>
202
210
<tr>
203
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
211
<td>
 
212
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
204
213
<td> a pointer to the <span class="type">AccessibleApplication</span> being queried.
205
214
</td>
206
215
</tr>
207
216
<tr>
208
 
<td><p><span class="term"><em class="parameter"><code>lc_category</code></em> :</span></p></td>
 
217
<td>
 
218
<span class="term"><em class="parameter"><code>lc_category</code></em> :</span></td>
209
219
<td> one of the POSIX LC_TYPE enumeration, for instance
210
220
LC_MESSAGES.
211
221
</td>
212
222
</tr>
213
223
<tr>
214
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
224
<td>
 
225
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
215
226
<td> a POSIX-compliant locale string, e.g. "C", "pt_BR", "sr<em class="parameter"><code>latn</code></em>", etc.
216
227
</td>
217
228
</tr>
233
244
<col align="left" valign="top">
234
245
<tbody>
235
246
<tr>
236
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
237
 
<td> a pointer to the <a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> object on which to operate.
 
247
<td>
 
248
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
 
249
<td> a pointer to the <a href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> object on which to operate.
238
250
</td>
239
251
</tr>
240
252
<tr>
241
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
242
 
<td> <span class="type">TRUE</span> if the application was paused successfully, <span class="type">FALSE</span> otherwise.
 
253
<td>
 
254
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
255
<td> <a
 
256
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
257
><span class="type">TRUE</span></a> if the application was paused successfully, <a
 
258
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
259
><span class="type">FALSE</span></a> otherwise.
243
260
 
244
261
</td>
245
262
</tr>
251
268
<a name="AccessibleApplication-resume"></a><h3>AccessibleApplication_resume ()</h3>
252
269
<pre class="programlisting">SPIBoolean          AccessibleApplication_resume        (AccessibleApplication *obj);</pre>
253
270
<p>
254
 
Attempt to resume the application (used after <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-pause" title="AccessibleApplication_pause ()"><span class="type">AccessibleApplication_pause</span></a>).
 
271
Attempt to resume the application (used after <a href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-pause" title="AccessibleApplication_pause ()"><span class="type">AccessibleApplication_pause</span></a>).
255
272
Not Yet Implemented.</p>
256
273
<p>
257
274
 
260
277
<col align="left" valign="top">
261
278
<tbody>
262
279
<tr>
263
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
264
 
<td> a pointer to the <a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> object on which to operate.
 
280
<td>
 
281
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
 
282
<td> a pointer to the <a href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> object on which to operate.
265
283
</td>
266
284
</tr>
267
285
<tr>
268
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
269
 
<td> <span class="type">TRUE</span> if application processing resumed successfully, <span class="type">FALSE</span> otherwise.
 
286
<td>
 
287
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
288
<td> <a
 
289
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
290
><span class="type">TRUE</span></a> if application processing resumed successfully, <a
 
291
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
292
><span class="type">FALSE</span></a> otherwise.
270
293
 
271
294
</td>
272
295
</tr>