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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Atk::EditableText Class Reference</h1>A AtkEditableText C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="editabletext_8hh-source.html">gfc/atk/editabletext.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Atk::EditableText:
<p><center><img src="classGFC_1_1Atk_1_1EditableText.png" usemap="#GFC::Atk::EditableText_map" border="0" alt=""></center>
<map name="GFC::Atk::EditableText_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="0,112,137,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,137,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,137,24">
</map>
<a href="classGFC_1_1Atk_1_1EditableText-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z10_0" doxytag="GFC::Atk::EditableText::atk_editable_text" ></a>
AtkEditableText * <a class="el" href="classGFC_1_1Atk_1_1EditableText.html#z10_0">atk_editable_text</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the AtkEditableText structure. <br></dl><li><a class="anchor" name="z10_1" doxytag="GFC::Atk::EditableText::operator AtkEditableText *" ></a>
<a class="el" href="classGFC_1_1Atk_1_1EditableText.html#z10_1">operator AtkEditableText *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classGFC_1_1Atk_1_1EditableText.html">EditableText</a> to an AtkEditableText pointer. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>bool <a class="el" href="classGFC_1_1Atk_1_1EditableText.html#z11_0">set_run_attributes</a> (const std::vector< <a class="el" href="classGFC_1_1Atk_1_1Attribute.html">Attribute</a> > &attribs, int start_offset, int end_offset)
<dl class="el"><dd class="mdescRight">Sets the attributes for a specified range. <a href="#z11_0"></a><br></dl><li>void <a class="el" href="classGFC_1_1Atk_1_1EditableText.html#z11_2">set_text_contents</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &str)
<dl class="el"><dd class="mdescRight">Set <em>str</em> as the text contents of the <a class="el" href="classGFC_1_1Atk_1_1EditableText.html">EditableText</a>. <a href="#z11_2"></a><br></dl><li>void <a class="el" href="classGFC_1_1Atk_1_1EditableText.html#z11_4">insert_text</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &str, int *position)
<dl class="el"><dd class="mdescRight">Insert text at the given <em>position</em>. <a href="#z11_4"></a><br></dl><li>void <a class="el" href="classGFC_1_1Atk_1_1EditableText.html#z11_5">copy_text</a> (int start_pos, int end_pos)
<dl class="el"><dd class="mdescRight">Copy text from <em>start_pos</em> up to, but not including <em>end_pos</em> to the clipboard. <a href="#z11_5"></a><br></dl><li>void <a class="el" href="classGFC_1_1Atk_1_1EditableText.html#z11_6">cut_text</a> (int start_pos, int end_pos)
<dl class="el"><dd class="mdescRight">Copy text from <em>start_pos</em> up to, but not including <em>end_pos</em> to the clipboard and then delete the text from the widget. <a href="#z11_6"></a><br></dl><li>void <a class="el" href="classGFC_1_1Atk_1_1EditableText.html#z11_7">delete_text</a> (int start_pos, int end_pos)
<dl class="el"><dd class="mdescRight">Delete text from <em>start_pos</em> up to, but not including <em>end_pos</em>. <a href="#z11_7"></a><br></dl><li>void <a class="el" href="classGFC_1_1Atk_1_1EditableText.html#z11_8">paste_text</a> (int position)
<dl class="el"><dd class="mdescRight">Paste text from the clipboard to the specified position. <a href="#z11_8"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z9_0" doxytag="GFC::Atk::EditableText::EditableText" ></a>
<a class="el" href="classGFC_1_1Atk_1_1EditableText.html#z9_0">EditableText</a> ()
<dl class="el"><dd class="mdescRight">Constructs a new <a class="el" href="classGFC_1_1Atk_1_1EditableText.html">EditableText</a> object. <br></dl><li><a class="anchor" name="z9_1" doxytag="GFC::Atk::EditableText::~EditableText" ></a>
virtual <a class="el" href="classGFC_1_1Atk_1_1EditableText.html#z9_1">~EditableText</a> ()=0
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A AtkEditableText C++ wrapper class.
<p>
The <a class="el" href="classGFC_1_1Atk_1_1EditableText.html">EditableText</a> interface should be implemented by UI components which contain text which the user can edit, via the <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> corresponding to that component (see <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a>).<p>
<a class="el" href="classGFC_1_1Atk_1_1EditableText.html">EditableText</a> is a subclass of <a class="el" href="classGFC_1_1Atk_1_1Text.html">Text</a>, and as such, an object which implements <a class="el" href="classGFC_1_1Atk_1_1EditableText.html">EditableText</a> is by definition a <a class="el" href="classGFC_1_1Atk_1_1Text.html">Text</a> implementor as well.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z11_5" doxytag="GFC::Atk::EditableText::copy_text" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Atk::EditableText::copy_text </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>start_pos</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>end_pos</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Copy text from <em>start_pos</em> up to, but not including <em>end_pos</em> to the clipboard.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>start_pos</em> </td><td>The start position. </td></tr>
<tr><td></td><td valign=top><em>end_pos</em> </td><td>The end position. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z11_6" doxytag="GFC::Atk::EditableText::cut_text" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Atk::EditableText::cut_text </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>start_pos</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>end_pos</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Copy text from <em>start_pos</em> up to, but not including <em>end_pos</em> to the clipboard and then delete the text from the widget.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>start_pos</em> </td><td>The start position. </td></tr>
<tr><td></td><td valign=top><em>end_pos</em> </td><td>The end position. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z11_7" doxytag="GFC::Atk::EditableText::delete_text" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Atk::EditableText::delete_text </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>start_pos</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>end_pos</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Delete text from <em>start_pos</em> up to, but not including <em>end_pos</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>start_pos</em> </td><td>The start position. </td></tr>
<tr><td></td><td valign=top><em>end_pos</em> </td><td>The end position. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z11_4" doxytag="GFC::Atk::EditableText::insert_text" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Atk::EditableText::insert_text </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>str</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int * </td>
<td class="mdname" nowrap> <em>position</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Insert text at the given <em>position</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>str</em> </td><td>The text to insert. </td></tr>
<tr><td></td><td valign=top><em>position</em> </td><td>The caller initializes this to the position at which to insert the text.</td></tr>
</table>
</dl>
<br>
When the method returns <em>position</em> points to the position after the newly inserted text. </td>
</tr>
</table>
<a class="anchor" name="z11_8" doxytag="GFC::Atk::EditableText::paste_text" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Atk::EditableText::paste_text </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>position</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Paste text from the clipboard to the specified position.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>position</em> </td><td>The position to paste the text to. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z11_0" doxytag="GFC::Atk::EditableText::set_run_attributes" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Atk::EditableText::set_run_attributes </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::vector< <a class="el" href="classGFC_1_1Atk_1_1Attribute.html">Attribute</a> > & </td>
<td class="mdname" nowrap> <em>attribs</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>start_offset</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>end_offset</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the attributes for a specified range.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>attribs</em> </td><td>A reference to a vector of <a class="el" href="classGFC_1_1Atk_1_1Attribute.html">Attribute</a> that holds the list of attributes to set. </td></tr>
<tr><td></td><td valign=top><em>start_offset</em> </td><td>The start of the range in which to set the attributes. </td></tr>
<tr><td></td><td valign=top><em>end_offset</em> </td><td>The end of the range in which to set the attributes. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the attributes were successfully set for the specified range, otherwise <em>false</em>.</dd></dl>
<br>
See the <a class="el" href="namespaceGFC_1_1Atk.html#a197">Atk::TextAttribute</a> enum for examples of attributes that can be set, such as TEXT_ATTR_LEFT_MARGIN. Note that other attributes that do not have a corresponding TextAttribute may also be set for certain text widgets. </td>
</tr>
</table>
<a class="anchor" name="z11_2" doxytag="GFC::Atk::EditableText::set_text_contents" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Atk::EditableText::set_text_contents </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>str</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set <em>str</em> as the text contents of the <a class="el" href="classGFC_1_1Atk_1_1EditableText.html">EditableText</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>str</em> </td><td>The string to set as the text contents of the <a class="el" href="classGFC_1_1Atk_1_1EditableText.html">EditableText</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="editabletext_8hh-source.html">editabletext.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:34 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
