← 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-AccessibleEditableText-Interface.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-AccessibleEditableText-Interface.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>AccessibleEditableText Interface</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-component.html" title="Subinterface Methods">
9
9
<link rel="prev" href="at-spi-cspi-AccessibleDocument-Interface.html" title="AccessibleDocument Interface">
41
41
<div class="refsynopsisdiv">
42
42
<a name="at-spi-cspi-AccessibleEditableText-Interface.synopsis"></a><h2>Synopsis</h2>
43
43
<pre class="synopsis">
44
 
void                <a class="link" href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-ref" title="AccessibleEditableText_ref ()">AccessibleEditableText_ref</a>          (AccessibleEditableText *obj);
45
 
void                <a class="link" href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-unref" title="AccessibleEditableText_unref ()">AccessibleEditableText_unref</a>        (AccessibleEditableText *obj);
46
 
SPIBoolean          <a class="link" href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-copyText" title="AccessibleEditableText_copyText ()">AccessibleEditableText_copyText</a>     (AccessibleText *obj,
47
 
                                                         long int startPos,
48
 
                                                         long int endPos);
49
 
SPIBoolean          <a class="link" href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-deleteText" title="AccessibleEditableText_deleteText ()">AccessibleEditableText_deleteText</a>   (AccessibleEditableText *obj,
50
 
                                                         long int startPos,
51
 
                                                         long int endPos);
52
 
SPIBoolean          <a class="link" href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-insertText" title="AccessibleEditableText_insertText ()">AccessibleEditableText_insertText</a>   (AccessibleEditableText *obj,
 
44
void                <a href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-ref" title="AccessibleEditableText_ref ()">AccessibleEditableText_ref</a>          (AccessibleEditableText *obj);
 
45
void                <a href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-unref" title="AccessibleEditableText_unref ()">AccessibleEditableText_unref</a>        (AccessibleEditableText *obj);
 
46
SPIBoolean          <a href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-copyText" title="AccessibleEditableText_copyText ()">AccessibleEditableText_copyText</a>     (AccessibleText *obj,
 
47
                                                         long int startPos,
 
48
                                                         long int endPos);
 
49
SPIBoolean          <a href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-deleteText" title="AccessibleEditableText_deleteText ()">AccessibleEditableText_deleteText</a>   (AccessibleEditableText *obj,
 
50
                                                         long int startPos,
 
51
                                                         long int endPos);
 
52
SPIBoolean          <a href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-insertText" title="AccessibleEditableText_insertText ()">AccessibleEditableText_insertText</a>   (AccessibleEditableText *obj,
53
53
                                                         long int position,
54
54
                                                         const char *text,
55
55
                                                         long int length);
56
 
SPIBoolean          <a class="link" href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-cutText" title="AccessibleEditableText_cutText ()">AccessibleEditableText_cutText</a>      (AccessibleEditableText *obj,
 
56
SPIBoolean          <a href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-cutText" title="AccessibleEditableText_cutText ()">AccessibleEditableText_cutText</a>      (AccessibleEditableText *obj,
57
57
                                                         long int startPos,
58
58
                                                         long int endPos);
59
 
SPIBoolean          <a class="link" href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-pasteText" title="AccessibleEditableText_pasteText ()">AccessibleEditableText_pasteText</a>    (AccessibleEditableText *obj,
 
59
SPIBoolean          <a href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-pasteText" title="AccessibleEditableText_pasteText ()">AccessibleEditableText_pasteText</a>    (AccessibleEditableText *obj,
60
60
                                                         long int position);
61
 
SPIBoolean          <a class="link" href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-setTextContents" title="AccessibleEditableText_setTextContents ()">AccessibleEditableText_setTextContents</a>
 
61
SPIBoolean          <a href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-setTextContents" title="AccessibleEditableText_setTextContents ()">AccessibleEditableText_setTextContents</a>
62
62
                                                        (AccessibleEditableText *obj,
63
63
                                                         const char *newContents);
64
 
SPIBoolean          <a class="link" href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-setAttributes" title="AccessibleEditableText_setAttributes ()">AccessibleEditableText_setAttributes</a>
 
64
SPIBoolean          <a href="at-spi-cspi-AccessibleEditableText-Interface.html#AccessibleEditableText-setAttributes" title="AccessibleEditableText_setAttributes ()">AccessibleEditableText_setAttributes</a>
65
65
                                                        (AccessibleEditableText *obj,
66
66
                                                         const char *attributes,
67
67
                                                         long int startOffset,
84
84
<p>
85
85
Increment the reference count for an <span class="type">AccessibleEditableText</span> object.
86
86
      Since AccessibleEditableText is derived from AccessibleText,
87
 
      this is the same as <a class="link" href="at-spi-cspi-AccessibleText-Interface.html#AccessibleText-ref" title="AccessibleText_ref ()"><code class="function">AccessibleText_ref()</code></a>.</p>
 
87
      this is the same as <a href="at-spi-cspi-AccessibleText-Interface.html#AccessibleText-ref" title="AccessibleText_ref ()"><code class="function">AccessibleText_ref()</code></a>.</p>
88
88
<p>
89
89
 
90
90
</p>
91
91
<div class="variablelist"><table border="0">
92
92
<col align="left" valign="top">
93
93
<tbody><tr>
94
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
94
<td>
 
95
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
95
96
<td> a pointer to the <span class="type">AccessibleEditableText</span> object on which to operate.
96
97
</td>
97
98
</tr></tbody>
104
105
<p>
105
106
Decrement the reference count for an <span class="type">AccessibleEdiitableText</span> object.
106
107
      Since AccessibleEditableText is derived from AccessibleText,
107
 
      this is the same as <a class="link" href="at-spi-cspi-AccessibleText-Interface.html#AccessibleText-unref" title="AccessibleText_unref ()"><code class="function">AccessibleText_unref()</code></a>.</p>
 
108
      this is the same as <a href="at-spi-cspi-AccessibleText-Interface.html#AccessibleText-unref" title="AccessibleText_unref ()"><code class="function">AccessibleText_unref()</code></a>.</p>
108
109
<p>
109
110
 
110
111
</p>
111
112
<div class="variablelist"><table border="0">
112
113
<col align="left" valign="top">
113
114
<tbody><tr>
114
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
115
<td>
 
116
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
115
117
<td> a pointer to the <span class="type">AccessibleEditableText</span> object on which to operate.
116
118
</td>
117
119
</tr></tbody>
135
137
<col align="left" valign="top">
136
138
<tbody>
137
139
<tr>
138
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
140
<td>
 
141
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
139
142
<td> a pointer to the <span class="type">AccessibleEditableText</span> object to modify.
140
143
</td>
141
144
</tr>
142
145
<tr>
143
 
<td><p><span class="term"><em class="parameter"><code>startPos</code></em> :</span></p></td>
 
146
<td>
 
147
<span class="term"><em class="parameter"><code>startPos</code></em> :</span></td>
144
148
<td> an integer indicating the starting character offset
145
149
      of the text to copy.
146
150
</td>
147
151
</tr>
148
152
<tr>
149
 
<td><p><span class="term"><em class="parameter"><code>endPos</code></em> :</span></p></td>
 
153
<td>
 
154
<span class="term"><em class="parameter"><code>endPos</code></em> :</span></td>
150
155
<td> an integer indicating the offset of the first character
151
156
      past the end of the text section to be copied.
152
157
</td>
153
158
</tr>
154
159
<tr>
155
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
156
 
<td> <span class="type">TRUE</span> if the operation was successful, otherwise <span class="type">FALSE</span>.
 
160
<td>
 
161
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
162
<td> <a
 
163
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
164
><span class="type">TRUE</span></a> if the operation was successful, otherwise <a
 
165
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
166
><span class="type">FALSE</span></a>.
157
167
</td>
158
168
</tr>
159
169
</tbody>
178
188
<col align="left" valign="top">
179
189
<tbody>
180
190
<tr>
181
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
191
<td>
 
192
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
182
193
<td> a pointer to the <span class="type">AccessibleEditableText</span> object to modify.
183
194
</td>
184
195
</tr>
185
196
<tr>
186
 
<td><p><span class="term"><em class="parameter"><code>startPos</code></em> :</span></p></td>
 
197
<td>
 
198
<span class="term"><em class="parameter"><code>startPos</code></em> :</span></td>
187
199
<td> an integer indicating the starting character offset
188
200
      of the text to delete.
189
201
</td>
190
202
</tr>
191
203
<tr>
192
 
<td><p><span class="term"><em class="parameter"><code>endPos</code></em> :</span></p></td>
 
204
<td>
 
205
<span class="term"><em class="parameter"><code>endPos</code></em> :</span></td>
193
206
<td> an integer indicating the offset of the first character
194
207
      past the end of the text section to be deleted.
195
208
</td>
196
209
</tr>
197
210
<tr>
198
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
199
 
<td> <span class="type">TRUE</span> if the operation was successful, otherwise <span class="type">FALSE</span>.
 
211
<td>
 
212
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
213
<td> <a
 
214
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
215
><span class="type">TRUE</span></a> if the operation was successful, otherwise <a
 
216
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
217
><span class="type">FALSE</span></a>.
200
218
</td>
201
219
</tr>
202
220
</tbody>
221
239
<col align="left" valign="top">
222
240
<tbody>
223
241
<tr>
224
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
242
<td>
 
243
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
225
244
<td> a pointer to the <span class="type">AccessibleEditableText</span> object to modify.
226
245
</td>
227
246
</tr>
228
247
<tr>
229
 
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
 
248
<td>
 
249
<span class="term"><em class="parameter"><code>position</code></em> :</span></td>
230
250
<td> an integer indicating the character offset at which to insert
231
251
      the new text.  
232
252
</td>
233
253
</tr>
234
254
<tr>
235
 
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
 
255
<td>
 
256
<span class="term"><em class="parameter"><code>text</code></em> :</span></td>
236
257
<td> a char* pointer to the text to insert, in UTF-8 encoding.
237
258
</td>
238
259
</tr>
239
260
<tr>
240
 
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
 
261
<td>
 
262
<span class="term"><em class="parameter"><code>length</code></em> :</span></td>
241
263
<td> (frankly I'm not sure this parameter should be here)
242
264
</td>
243
265
</tr>
244
266
<tr>
245
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
246
 
<td> <span class="type">TRUE</span> if the operation was successful, otherwise <span class="type">FALSE</span>.
 
267
<td>
 
268
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
269
<td> <a
 
270
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
271
><span class="type">TRUE</span></a> if the operation was successful, otherwise <a
 
272
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
273
><span class="type">FALSE</span></a>.
247
274
</td>
248
275
</tr>
249
276
</tbody>
268
295
<col align="left" valign="top">
269
296
<tbody>
270
297
<tr>
271
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
298
<td>
 
299
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
272
300
<td> a pointer to the <span class="type">AccessibleEditableText</span> object to modify.
273
301
</td>
274
302
</tr>
275
303
<tr>
276
 
<td><p><span class="term"><em class="parameter"><code>startPos</code></em> :</span></p></td>
 
304
<td>
 
305
<span class="term"><em class="parameter"><code>startPos</code></em> :</span></td>
277
306
<td> an integer indicating the starting character offset
278
307
      of the text to cut.
279
308
</td>
280
309
</tr>
281
310
<tr>
282
 
<td><p><span class="term"><em class="parameter"><code>endPos</code></em> :</span></p></td>
 
311
<td>
 
312
<span class="term"><em class="parameter"><code>endPos</code></em> :</span></td>
283
313
<td> an integer indicating the offset of the first character
284
314
      past the end of the text section to be cut.
285
315
</td>
286
316
</tr>
287
317
<tr>
288
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
289
 
<td> <span class="type">TRUE</span> if operation was successful, <span class="type">FALSE</span> otherwise.
 
318
<td>
 
319
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
320
<td> <a
 
321
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
322
><span class="type">TRUE</span></a> if operation was successful, <a
 
323
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
324
><span class="type">FALSE</span></a> otherwise.
290
325
</td>
291
326
</tr>
292
327
</tbody>
309
344
<col align="left" valign="top">
310
345
<tbody>
311
346
<tr>
312
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
347
<td>
 
348
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
313
349
<td> a pointer to the <span class="type">AccessibleEditableText</span> object to modify.
314
350
</td>
315
351
</tr>
316
352
<tr>
317
 
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
 
353
<td>
 
354
<span class="term"><em class="parameter"><code>position</code></em> :</span></td>
318
355
<td> an integer indicating the character offset at which to insert
319
356
      the new text.  
320
357
</td>
321
358
</tr>
322
359
<tr>
323
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
324
 
<td> <span class="type">TRUE</span> if the operation was successful, otherwise <span class="type">FALSE</span>.
 
360
<td>
 
361
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
362
<td> <a
 
363
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
364
><span class="type">TRUE</span></a> if the operation was successful, otherwise <a
 
365
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
366
><span class="type">FALSE</span></a>.
325
367
</td>
326
368
</tr>
327
369
</tbody>
342
384
<col align="left" valign="top">
343
385
<tbody>
344
386
<tr>
345
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
387
<td>
 
388
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
346
389
<td> a pointer to the <span class="type">AccessibleEditableText</span> object to modify.
347
390
</td>
348
391
</tr>
349
392
<tr>
350
 
<td><p><span class="term"><em class="parameter"><code>newContents</code></em> :</span></p></td>
 
393
<td>
 
394
<span class="term"><em class="parameter"><code>newContents</code></em> :</span></td>
351
395
<td> a character string, encoded in UTF-8, which is to
352
396
     become the new text contents of the <span class="type">AccessibleEditableText</span> object.
353
397
</td>
354
398
</tr>
355
399
<tr>
356
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
357
 
<td> <span class="type">TRUE</span> if the operation was successful, otherwise <span class="type">FALSE</span>.
 
400
<td>
 
401
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
402
<td> <a
 
403
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
404
><span class="type">TRUE</span></a> if the operation was successful, otherwise <a
 
405
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
406
><span class="type">FALSE</span></a>.
358
407
</td>
359
408
</tr>
360
409
</tbody>
378
427
<col align="left" valign="top">
379
428
<tbody>
380
429
<tr>
381
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
430
<td>
 
431
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
382
432
<td> a pointer to the <span class="type">AccessibleEditableText</span> object to modify.
383
433
</td>
384
434
</tr>
385
435
<tr>
386
 
<td><p><span class="term"><em class="parameter"><code>attributes</code></em> :</span></p></td>
 
436
<td>
 
437
<span class="term"><em class="parameter"><code>attributes</code></em> :</span></td>
387
438
<td> a character string indicating the attributes to apply to the range,
388
439
       delimited by ':'.
389
440
</td>
390
441
</tr>
391
442
<tr>
392
 
<td><p><span class="term"><em class="parameter"><code>startOffset</code></em> :</span></p></td>
 
443
<td>
 
444
<span class="term"><em class="parameter"><code>startOffset</code></em> :</span></td>
393
445
<td> a <span class="type">long</span> indicating the start of the desired text range.
394
446
</td>
395
447
</tr>
396
448
<tr>
397
 
<td><p><span class="term"><em class="parameter"><code>endOffset</code></em> :</span></p></td>
 
449
<td>
 
450
<span class="term"><em class="parameter"><code>endOffset</code></em> :</span></td>
398
451
<td> a <span class="type">long</span> indicating the first character past the desired range.
399
452
</td>
400
453
</tr>
401
454
<tr>
402
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
403
 
<td> <span class="type">TRUE</span> if the operation was successful, otherwise <span class="type">FALSE</span>.
 
455
<td>
 
456
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
457
<td> <a
 
458
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
459
><span class="type">TRUE</span></a> if the operation was successful, otherwise <a
 
460
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
461
><span class="type">FALSE</span></a>.
404
462
</td>
405
463
</tr>
406
464
</tbody>