4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>AtkEditableText</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="ATK - Accessibility Toolkit">
8
8
<link rel="up" href="atk.html" title="ATK Library">
9
9
<link rel="prev" href="AtkDocument.html" title="AtkDocument">
10
10
<link rel="next" href="AtkGObjectAccessible.html" title="AtkGObjectAccessible">
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="atk.html" title="ATK Library">
14
14
<link rel="index" href="ix01.html" title="Index">
28
28
<th width="100%" align="center">ATK - Accessibility Toolkit</th>
29
29
<td><a accesskey="n" href="AtkGObjectAccessible.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id335825" class="shortcut">Top</a>
33
<a href="#id336487" class="shortcut">Description</a>
35
<a href="#id336442" class="shortcut">Object Hierarchy</a>
37
<a href="#id336466" class="shortcut">Known Implementations</a></nobr></td></tr>
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id351710" class="shortcut">Top</a>
33
<a href="#id352371" class="shortcut">Description</a>
35
<a href="#id352326" class="shortcut">Object Hierarchy</a>
37
<a href="#id352350" class="shortcut">Known Implementations</a></nobr></td></tr>
39
39
<div class="refentry" lang="en">
40
40
<a name="AtkEditableText"></a><div class="titlepage"></div>
41
41
<div class="refnamediv"><table width="100%"><tr>
44
<a name="id335825"></a><span class="refentrytitle">AtkEditableText</span>
44
<a name="id351710"></a><span class="refentrytitle">AtkEditableText</span>
46
46
<p>AtkEditableText — The ATK interface implemented by components containing user-editable text content.</p>
56
<a href="AtkEditableText.html#AtkEditableText-struct">AtkEditableText</a>;
57
gboolean <a href="AtkEditableText.html#atk-editable-text-set-run-attributes">atk_editable_text_set_run_attributes</a>
58
(<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
59
<a href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a> *attrib_set,
56
<a class="link" href="AtkEditableText.html#AtkEditableText-struct">AtkEditableText</a>;
57
gboolean <a class="link" href="AtkEditableText.html#atk-editable-text-set-run-attributes">atk_editable_text_set_run_attributes</a>
58
(<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
59
<a class="link" href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a> *attrib_set,
62
void <a href="AtkEditableText.html#atk-editable-text-set-text-contents">atk_editable_text_set_text_contents</a> (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
62
void <a class="link" href="AtkEditableText.html#atk-editable-text-set-text-contents">atk_editable_text_set_text_contents</a> (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
63
63
const gchar *string);
64
void <a href="AtkEditableText.html#atk-editable-text-insert-text">atk_editable_text_insert_text</a> (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
64
void <a class="link" href="AtkEditableText.html#atk-editable-text-insert-text">atk_editable_text_insert_text</a> (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
65
65
const gchar *string,
68
void <a href="AtkEditableText.html#atk-editable-text-copy-text">atk_editable_text_copy_text</a> (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
71
void <a href="AtkEditableText.html#atk-editable-text-cut-text">atk_editable_text_cut_text</a> (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
74
void <a href="AtkEditableText.html#atk-editable-text-delete-text">atk_editable_text_delete_text</a> (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
77
void <a href="AtkEditableText.html#atk-editable-text-paste-text">atk_editable_text_paste_text</a> (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
68
void <a class="link" href="AtkEditableText.html#atk-editable-text-copy-text">atk_editable_text_copy_text</a> (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
71
void <a class="link" href="AtkEditableText.html#atk-editable-text-cut-text">atk_editable_text_cut_text</a> (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
74
void <a class="link" href="AtkEditableText.html#atk-editable-text-delete-text">atk_editable_text_delete_text</a> (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
77
void <a class="link" href="AtkEditableText.html#atk-editable-text-paste-text">atk_editable_text_paste_text</a> (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
82
82
<div class="refsect1" lang="en">
83
<a name="id336442"></a><h2>Object Hierarchy</h2>
83
<a name="id352326"></a><h2>Object Hierarchy</h2>
84
84
<pre class="synopsis">
90
90
<div class="refsect1" lang="en">
91
<a name="id336466"></a><h2>Known Implementations</h2>
91
<a name="id352350"></a><h2>Known Implementations</h2>
93
93
AtkEditableText is implemented by
94
<a href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
96
<div class="refsect1" lang="en">
97
<a name="id336487"></a><h2>Description</h2>
99
<a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> should be implemented by UI components which contain
100
text which the user can edit, via the <a href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> corresponding to that
101
component (see <a href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>).
104
<a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> is a subclass of <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>, and as such, an object which
105
implements <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> is by definition an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> implementor as well.
108
<div class="refsect1" lang="en">
109
<a name="id336562"></a><h2>Details</h2>
94
<a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
96
<div class="refsect1" lang="en">
97
<a name="id352371"></a><h2>Description</h2>
99
<a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> should be implemented by UI components which contain
100
text which the user can edit, via the <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> corresponding to that
101
component (see <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>).
104
<a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> is a subclass of <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>, and as such, an object which
105
implements <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> is by definition an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> implementor as well.
108
<div class="refsect1" lang="en">
109
<a name="id352446"></a><h2>Details</h2>
110
110
<div class="refsect2" lang="en">
111
<a name="id336572"></a><h3>
111
<a name="id352456"></a><h3>
112
112
<a name="AtkEditableText-struct"></a>AtkEditableText</h3>
113
<a class="indexterm" name="id336584"></a><pre class="programlisting">typedef struct _AtkEditableText AtkEditableText;</pre>
113
<a class="indexterm" name="id352468"></a><pre class="programlisting">typedef struct _AtkEditableText AtkEditableText;</pre>
115
115
The AtkEditableText structure does not contain any fields.
120
120
<div class="refsect2" lang="en">
121
<a name="id336599"></a><h3>
121
<a name="id352484"></a><h3>
122
122
<a name="atk-editable-text-set-run-attributes"></a>atk_editable_text_set_run_attributes ()</h3>
123
<a class="indexterm" name="id336612"></a><pre class="programlisting">gboolean atk_editable_text_set_run_attributes
124
(<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
125
<a href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a> *attrib_set,
123
<a class="indexterm" name="id352496"></a><pre class="programlisting">gboolean atk_editable_text_set_run_attributes
124
(<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
125
<a class="link" href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a> *attrib_set,
126
126
gint start_offset,
127
127
gint end_offset);</pre>
137
137
<col align="left" valign="top">
140
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
141
<td> an <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
145
<td><span class="term"><em class="parameter"><code>attrib_set</code></em> :</span></td>
146
<td> an <a href="AtkText.html#AtkAttributeSet"><span class="type">AtkAttributeSet</span></a>
150
<td><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></td>
140
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
141
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
145
<td><p><span class="term"><em class="parameter"><code>attrib_set</code></em> :</span></p></td>
146
<td> an <a class="link" href="AtkText.html#AtkAttributeSet"><span class="type">AtkAttributeSet</span></a>
150
<td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
151
151
<td> start of range in which to set attributes
155
<td><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></td>
155
<td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
156
156
<td> end of range in which to set attributes
160
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
160
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
161
161
<td> <code class="literal">TRUE</code> if attributes successfully set for the specified
162
162
range, otherwise <code class="literal">FALSE</code>
169
169
<div class="refsect2" lang="en">
170
<a name="id336783"></a><h3>
170
<a name="id352667"></a><h3>
171
171
<a name="atk-editable-text-set-text-contents"></a>atk_editable_text_set_text_contents ()</h3>
172
<a class="indexterm" name="id336795"></a><pre class="programlisting">void atk_editable_text_set_text_contents (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
172
<a class="indexterm" name="id352679"></a><pre class="programlisting">void atk_editable_text_set_text_contents (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
173
173
const gchar *string);</pre>
175
175
Set text contents of <em class="parameter"><code>text</code></em>.</p>
180
180
<col align="left" valign="top">
183
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
184
<td> an <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
183
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
184
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
188
<td><span class="term"><em class="parameter"><code>string</code></em> :</span></td>
188
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
189
189
<td> string to set for text contents of <em class="parameter"><code>text</code></em>
196
196
<div class="refsect2" lang="en">
197
<a name="id336885"></a><h3>
197
<a name="id352769"></a><h3>
198
198
<a name="atk-editable-text-insert-text"></a>atk_editable_text_insert_text ()</h3>
199
<a class="indexterm" name="id336897"></a><pre class="programlisting">void atk_editable_text_insert_text (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
199
<a class="indexterm" name="id352781"></a><pre class="programlisting">void atk_editable_text_insert_text (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
200
200
const gchar *string,
202
202
gint *position);</pre>
209
209
<col align="left" valign="top">
212
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
213
<td> an <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
212
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
213
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
217
<td><span class="term"><em class="parameter"><code>string</code></em> :</span></td>
217
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
218
218
<td> the text to insert
222
<td><span class="term"><em class="parameter"><code>length</code></em> :</span></td>
222
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
223
223
<td> the length of text to insert, in bytes
227
<td><span class="term"><em class="parameter"><code>position</code></em> :</span></td>
227
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
228
228
<td> The caller initializes this to
229
229
the position at which to insert the text. After the call it
230
230
points at the position after the newly inserted text.
237
237
<div class="refsect2" lang="en">
238
<a name="id337019"></a><h3>
238
<a name="id352903"></a><h3>
239
239
<a name="atk-editable-text-copy-text"></a>atk_editable_text_copy_text ()</h3>
240
<a class="indexterm" name="id337031"></a><pre class="programlisting">void atk_editable_text_copy_text (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
240
<a class="indexterm" name="id352915"></a><pre class="programlisting">void atk_editable_text_copy_text (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
242
242
gint end_pos);</pre>
250
250
<col align="left" valign="top">
253
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
254
<td> an <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
253
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
254
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
258
<td><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></td>
258
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
259
259
<td> start position
263
<td><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></td>
263
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
264
264
<td> end position
271
271
<div class="refsect2" lang="en">
272
<a name="id337142"></a><h3>
272
<a name="id353027"></a><h3>
273
273
<a name="atk-editable-text-cut-text"></a>atk_editable_text_cut_text ()</h3>
274
<a class="indexterm" name="id337155"></a><pre class="programlisting">void atk_editable_text_cut_text (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
274
<a class="indexterm" name="id353039"></a><pre class="programlisting">void atk_editable_text_cut_text (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
276
276
gint end_pos);</pre>
284
284
<col align="left" valign="top">
287
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
288
<td> an <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
287
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
288
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
292
<td><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></td>
292
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
293
293
<td> start position
297
<td><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></td>
297
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
298
298
<td> end position
305
305
<div class="refsect2" lang="en">
306
<a name="id337266"></a><h3>
306
<a name="id353150"></a><h3>
307
307
<a name="atk-editable-text-delete-text"></a>atk_editable_text_delete_text ()</h3>
308
<a class="indexterm" name="id337279"></a><pre class="programlisting">void atk_editable_text_delete_text (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
308
<a class="indexterm" name="id353163"></a><pre class="programlisting">void atk_editable_text_delete_text (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
310
310
gint end_pos);</pre>
317
317
<col align="left" valign="top">
320
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
321
<td> an <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
320
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
321
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
325
<td><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></td>
325
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
326
326
<td> start position
330
<td><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></td>
330
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
331
331
<td> end position
338
338
<div class="refsect2" lang="en">
339
<a name="id337390"></a><h3>
339
<a name="id353274"></a><h3>
340
340
<a name="atk-editable-text-paste-text"></a>atk_editable_text_paste_text ()</h3>
341
<a class="indexterm" name="id337402"></a><pre class="programlisting">void atk_editable_text_paste_text (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
341
<a class="indexterm" name="id353286"></a><pre class="programlisting">void atk_editable_text_paste_text (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
342
342
gint position);</pre>
344
344
Paste text from clipboard to specified <em class="parameter"><code>position</code></em>.</p>
349
349
<col align="left" valign="top">
352
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
353
<td> an <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
352
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
353
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
357
<td><span class="term"><em class="parameter"><code>position</code></em> :</span></td>
357
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
358
358
<td> position to paste
365
365
<div class="refsect1" lang="en">
366
<a name="id337487"></a><h2>See Also</h2>
366
<a name="id353371"></a><h2>See Also</h2>
368
<a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
368
<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
371
<div class="refsect1" lang="en">
372
<a name="id353389"></a><div class="refsect2" lang="en"><a name="id353390"></a></div>
374
<div class="refsect2" lang="en"><a name="id353391"></a></div>