4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>AtkEditableText</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" 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.11 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="chapter" href="atk.html" title="ATK Library">
14
<link rel="index" href="ix01.html" title="Index">
15
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
16
<link rel="index" href="ix03.html" title="Index of new symbols in ATK 1.3">
17
<link rel="index" href="ix04.html" title="Index of new symbols in ATK 1.4">
18
<link rel="index" href="ix05.html" title="Index of new symbols in ATK 1.6">
19
<link rel="index" href="ix06.html" title="Index of new symbols in ATK 1.9">
20
<link rel="index" href="ix07.html" title="Index of new symbols in ATK 1.12">
22
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
31
23
<tr><td colspan="5" class="shortcuts">
32
24
<a href="#AtkEditableText.synopsis" class="shortcut">Top</a>
34
<a href="#AtkEditableText.description" class="shortcut">Description</a>
36
<a href="#AtkEditableText.object-hierarchy" class="shortcut">Object Hierarchy</a>
38
<a href="#AtkEditableText.implementations" class="shortcut">Known Implementations</a>
26
<a href="#AtkEditableText.description" class="shortcut">Description</a>
28
<a href="#AtkEditableText.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#AtkEditableText.implementations" class="shortcut">Known Implementations</a>
41
33
<div class="refentry" title="AtkEditableText">
49
41
</tr></table></div>
50
42
<div class="refsynopsisdiv" title="Synopsis">
51
43
<a name="AtkEditableText.synopsis"></a><h2>Synopsis</h2>
52
<pre class="synopsis">
53
<a class="link" href="AtkEditableText.html#AtkEditableText-struct" title="AtkEditableText">AtkEditableText</a>;
54
gboolean <a class="link" href="AtkEditableText.html#atk-editable-text-set-run-attributes" title="atk_editable_text_set_run_attributes ()">atk_editable_text_set_run_attributes</a>
55
(<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
56
<a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet">AtkAttributeSet</a> *attrib_set,
59
void <a class="link" href="AtkEditableText.html#atk-editable-text-set-text-contents" title="atk_editable_text_set_text_contents ()">atk_editable_text_set_text_contents</a> (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
61
void <a class="link" href="AtkEditableText.html#atk-editable-text-insert-text" title="atk_editable_text_insert_text ()">atk_editable_text_insert_text</a> (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
65
void <a class="link" href="AtkEditableText.html#atk-editable-text-copy-text" title="atk_editable_text_copy_text ()">atk_editable_text_copy_text</a> (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
68
void <a class="link" href="AtkEditableText.html#atk-editable-text-cut-text" title="atk_editable_text_cut_text ()">atk_editable_text_cut_text</a> (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
71
void <a class="link" href="AtkEditableText.html#atk-editable-text-delete-text" title="atk_editable_text_delete_text ()">atk_editable_text_delete_text</a> (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
74
void <a class="link" href="AtkEditableText.html#atk-editable-text-paste-text" title="atk_editable_text_paste_text ()">atk_editable_text_paste_text</a> (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
44
<pre class="synopsis"> <a class="link" href="AtkEditableText.html#AtkEditableText-struct" title="AtkEditableText">AtkEditableText</a>;
45
<span class="returnvalue">gboolean</span> <a class="link" href="AtkEditableText.html#atk-editable-text-set-run-attributes" title="atk_editable_text_set_run_attributes ()">atk_editable_text_set_run_attributes</a>
46
(<em class="parameter"><code><a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> *text</code></em>,
47
<em class="parameter"><code><a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> *attrib_set</code></em>,
48
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
49
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>);
50
<span class="returnvalue">void</span> <a class="link" href="AtkEditableText.html#atk-editable-text-set-text-contents" title="atk_editable_text_set_text_contents ()">atk_editable_text_set_text_contents</a> (<em class="parameter"><code><a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> *text</code></em>,
51
<em class="parameter"><code>const <span class="type">gchar</span> *string</code></em>);
52
<span class="returnvalue">void</span> <a class="link" href="AtkEditableText.html#atk-editable-text-insert-text" title="atk_editable_text_insert_text ()">atk_editable_text_insert_text</a> (<em class="parameter"><code><a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> *text</code></em>,
53
<em class="parameter"><code>const <span class="type">gchar</span> *string</code></em>,
54
<em class="parameter"><code><span class="type">gint</span> length</code></em>,
55
<em class="parameter"><code><span class="type">gint</span> *position</code></em>);
56
<span class="returnvalue">void</span> <a class="link" href="AtkEditableText.html#atk-editable-text-copy-text" title="atk_editable_text_copy_text ()">atk_editable_text_copy_text</a> (<em class="parameter"><code><a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> *text</code></em>,
57
<em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
58
<em class="parameter"><code><span class="type">gint</span> end_pos</code></em>);
59
<span class="returnvalue">void</span> <a class="link" href="AtkEditableText.html#atk-editable-text-cut-text" title="atk_editable_text_cut_text ()">atk_editable_text_cut_text</a> (<em class="parameter"><code><a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> *text</code></em>,
60
<em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
61
<em class="parameter"><code><span class="type">gint</span> end_pos</code></em>);
62
<span class="returnvalue">void</span> <a class="link" href="AtkEditableText.html#atk-editable-text-delete-text" title="atk_editable_text_delete_text ()">atk_editable_text_delete_text</a> (<em class="parameter"><code><a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> *text</code></em>,
63
<em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
64
<em class="parameter"><code><span class="type">gint</span> end_pos</code></em>);
65
<span class="returnvalue">void</span> <a class="link" href="AtkEditableText.html#atk-editable-text-paste-text" title="atk_editable_text_paste_text ()">atk_editable_text_paste_text</a> (<em class="parameter"><code><a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> *text</code></em>,
66
<em class="parameter"><code><span class="type">gint</span> position</code></em>);
78
69
<div class="refsect1" title="Object Hierarchy">
113
104
<div class="refsect2" title="atk_editable_text_set_run_attributes ()">
114
105
<a name="atk-editable-text-set-run-attributes"></a><h3>atk_editable_text_set_run_attributes ()</h3>
115
<pre class="programlisting">gboolean atk_editable_text_set_run_attributes
116
(<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
117
<a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet">AtkAttributeSet</a> *attrib_set,
119
gint end_offset);</pre>
106
<pre class="programlisting"><span class="returnvalue">gboolean</span> atk_editable_text_set_run_attributes
107
(<em class="parameter"><code><a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> *text</code></em>,
108
<em class="parameter"><code><a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> *attrib_set</code></em>,
109
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
110
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>);</pre>
121
112
Sets the attributes for a specified range. See the ATK_ATTRIBUTE
122
113
macros (such as <span class="type">ATK_ATTRIBUTE_LEFT_MARGIN</span>) for examples of attributes
123
114
that can be set. Note that other attributes that do not have corresponding
124
ATK_ATTRIBUTE macros may also be set for certain text widgets.</p>
115
ATK_ATTRIBUTE macros may also be set for certain text widgets.
127
117
<div class="variablelist"><table border="0">
128
118
<col align="left" valign="top">
131
121
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
132
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
122
<td>an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
136
126
<td><p><span class="term"><em class="parameter"><code>attrib_set</code></em> :</span></p></td>
137
<td> an <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a>
127
<td>an <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a>
141
131
<td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
142
<td> start of range in which to set attributes
132
<td>start of range in which to set attributes
146
136
<td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
147
<td> end of range in which to set attributes
137
<td>end of range in which to set attributes
160
150
<div class="refsect2" title="atk_editable_text_set_text_contents ()">
161
151
<a name="atk-editable-text-set-text-contents"></a><h3>atk_editable_text_set_text_contents ()</h3>
162
<pre class="programlisting">void atk_editable_text_set_text_contents (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
163
const gchar *string);</pre>
165
Set text contents of <em class="parameter"><code>text</code></em>.</p>
152
<pre class="programlisting"><span class="returnvalue">void</span> atk_editable_text_set_text_contents (<em class="parameter"><code><a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> *text</code></em>,
153
<em class="parameter"><code>const <span class="type">gchar</span> *string</code></em>);</pre>
155
Set text contents of <em class="parameter"><code>text</code></em>.
168
157
<div class="variablelist"><table border="0">
169
158
<col align="left" valign="top">
172
161
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
173
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
162
<td>an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
177
166
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
178
<td> string to set for text contents of <em class="parameter"><code>text</code></em>
167
<td>string to set for text contents of <em class="parameter"><code>text</code></em>
185
174
<div class="refsect2" title="atk_editable_text_insert_text ()">
186
175
<a name="atk-editable-text-insert-text"></a><h3>atk_editable_text_insert_text ()</h3>
187
<pre class="programlisting">void atk_editable_text_insert_text (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
190
gint *position);</pre>
192
Insert text at a given position.</p>
176
<pre class="programlisting"><span class="returnvalue">void</span> atk_editable_text_insert_text (<em class="parameter"><code><a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> *text</code></em>,
177
<em class="parameter"><code>const <span class="type">gchar</span> *string</code></em>,
178
<em class="parameter"><code><span class="type">gint</span> length</code></em>,
179
<em class="parameter"><code><span class="type">gint</span> *position</code></em>);</pre>
181
Insert text at a given position.
195
183
<div class="variablelist"><table border="0">
196
184
<col align="left" valign="top">
199
187
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
200
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
188
<td>an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
204
192
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
205
<td> the text to insert
193
<td>the text to insert
209
197
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
210
<td> the length of text to insert, in bytes
198
<td>the length of text to insert, in bytes
214
202
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
215
<td> The caller initializes this to
203
<td>The caller initializes this to
216
204
the position at which to insert the text. After the call it
217
205
points at the position after the newly inserted text.
224
212
<div class="refsect2" title="atk_editable_text_copy_text ()">
225
213
<a name="atk-editable-text-copy-text"></a><h3>atk_editable_text_copy_text ()</h3>
226
<pre class="programlisting">void atk_editable_text_copy_text (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
214
<pre class="programlisting"><span class="returnvalue">void</span> atk_editable_text_copy_text (<em class="parameter"><code><a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> *text</code></em>,
215
<em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
216
<em class="parameter"><code><span class="type">gint</span> end_pos</code></em>);</pre>
230
218
Copy text from <em class="parameter"><code>start_pos</code></em> up to, but not including <em class="parameter"><code>end_pos</code></em>
231
to the clipboard.</p>
234
221
<div class="variablelist"><table border="0">
235
222
<col align="left" valign="top">
238
225
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
239
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
226
<td>an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
243
230
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
248
235
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
256
243
<div class="refsect2" title="atk_editable_text_cut_text ()">
257
244
<a name="atk-editable-text-cut-text"></a><h3>atk_editable_text_cut_text ()</h3>
258
<pre class="programlisting">void atk_editable_text_cut_text (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
245
<pre class="programlisting"><span class="returnvalue">void</span> atk_editable_text_cut_text (<em class="parameter"><code><a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> *text</code></em>,
246
<em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
247
<em class="parameter"><code><span class="type">gint</span> end_pos</code></em>);</pre>
262
249
Copy text from <em class="parameter"><code>start_pos</code></em> up to, but not including <em class="parameter"><code>end_pos</code></em>
263
to the clipboard and then delete from the widget.</p>
250
to the clipboard and then delete from the widget.
266
252
<div class="variablelist"><table border="0">
267
253
<col align="left" valign="top">
270
256
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
271
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
257
<td>an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
275
261
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
280
266
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
288
274
<div class="refsect2" title="atk_editable_text_delete_text ()">
289
275
<a name="atk-editable-text-delete-text"></a><h3>atk_editable_text_delete_text ()</h3>
290
<pre class="programlisting">void atk_editable_text_delete_text (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
294
Delete text <em class="parameter"><code>start_pos</code></em> up to, but not including <em class="parameter"><code>end_pos</code></em>.</p>
276
<pre class="programlisting"><span class="returnvalue">void</span> atk_editable_text_delete_text (<em class="parameter"><code><a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> *text</code></em>,
277
<em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
278
<em class="parameter"><code><span class="type">gint</span> end_pos</code></em>);</pre>
280
Delete text <em class="parameter"><code>start_pos</code></em> up to, but not including <em class="parameter"><code>end_pos</code></em>.
297
282
<div class="variablelist"><table border="0">
298
283
<col align="left" valign="top">
301
286
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
302
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
287
<td>an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
306
291
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
311
296
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
319
304
<div class="refsect2" title="atk_editable_text_paste_text ()">
320
305
<a name="atk-editable-text-paste-text"></a><h3>atk_editable_text_paste_text ()</h3>
321
<pre class="programlisting">void atk_editable_text_paste_text (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
322
gint position);</pre>
324
Paste text from clipboard to specified <em class="parameter"><code>position</code></em>.</p>
306
<pre class="programlisting"><span class="returnvalue">void</span> atk_editable_text_paste_text (<em class="parameter"><code><a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> *text</code></em>,
307
<em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre>
309
Paste text from clipboard to specified <em class="parameter"><code>position</code></em>.
327
311
<div class="variablelist"><table border="0">
328
312
<col align="left" valign="top">
331
315
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
332
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
316
<td>an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
336
320
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
337
<td> position to paste
321
<td>position to paste