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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
|
<!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>text.hh File Reference</h1>An AtkText C++ wrapper interface. <a href="#_details">More...</a>
<p>
<code>#include <<a class="elRef" doxygen="gfccore.tag:" href="type_8hh.html">gfc/glib/type.hh</a>></code><br>
<code>#include <<a class="el" href="util_8hh-source.html">gfc/atk/util.hh</a>></code><br>
<code>#include <atk/atktext.h></code><br>
<code>#include <vector></code><br>
<code>#include <gfc/atk/inline/text.inl></code><br>
<p>
<a href="text_8hh-source.html">Go to the source code of this file.</a><h2>Namespaces</h2>
<ul>
<li>namespace <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC.html">GFC</a>
<li>namespace <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC::G.html">GFC::G</a>
<li>namespace <a class="el" href="namespaceGFC_1_1Atk.html">GFC::Atk</a>
</ul>
<h2>Classes</h2>
<ul>
<li>class <a class="el" href="classGFC_1_1Atk_1_1Attribute.html">GFC::Atk::Attribute</a>
<dl class="el"><dd class="mdescRight">A AtkAttribute C++ wrapper class. <a href="classGFC_1_1Atk_1_1Attribute.html#_details">More...</a><br></dl><li>class <a class="el" href="classGFC_1_1Atk_1_1TextRectangle.html">GFC::Atk::TextRectangle</a>
<dl class="el"><dd class="mdescRight">An AtkTextRectangle C++ wrapper class. <a href="classGFC_1_1Atk_1_1TextRectangle.html#_details">More...</a><br></dl><li>class <a class="el" href="classGFC_1_1Atk_1_1TextRange.html">GFC::Atk::TextRange</a>
<dl class="el"><dd class="mdescRight">A AtkTextRange C++ wrapper class. <a href="classGFC_1_1Atk_1_1TextRange.html#_details">More...</a><br></dl><li>class <a class="el" href="classGFC_1_1Atk_1_1Text.html">GFC::Atk::Text</a>
<dl class="el"><dd class="mdescRight">A AtkText C++ wrapper class. <a href="classGFC_1_1Atk_1_1Text.html#_details">More...</a><br></dl></ul>
<h2>TextAttibute Methods</h2>
<ul>
<li><a class="el" href="namespaceGFC_1_1Atk.html#a197">TextAttribute</a> <a class="el" href="namespaceGFC_1_1Atk.html#a183">text_attribute_register</a> (const String &name)
<dl class="el"><dd class="mdescRight">Associate name with a new TextAttribute. <a href="#a183"></a><br></dl><li>String <a class="el" href="namespaceGFC_1_1Atk.html#a184">text_attribute_get_name</a> (<a class="el" href="namespaceGFC_1_1Atk.html#a197">TextAttribute</a> attr)
<dl class="el"><dd class="mdescRight">Gets the name corresponding to the TextAttribute. <a href="#a184"></a><br></dl><li><a class="el" href="namespaceGFC_1_1Atk.html#a197">TextAttribute</a> <a class="el" href="namespaceGFC_1_1Atk.html#a185">text_attribute_for_name</a> (const String &name)
<dl class="el"><dd class="mdescRight">Get the TextAttribute type corresponding to a text attribute <em>name</em>. <a href="#a185"></a><br></dl><li>String <a class="el" href="namespaceGFC_1_1Atk.html#a186">text_attribute_get_value</a> (<a class="el" href="namespaceGFC_1_1Atk.html#a197">TextAttribute</a> attr, int index)
<dl class="el"><dd class="mdescRight">Gets the value for the index of the text attribute <em>attr</em>. <a href="#a186"></a><br></dl></ul>
<h2>Enumerations</h2>
<ul>
<li>enum <a class="el" href="namespaceGFC_1_1Atk.html#a197">TextAttribute</a> { <br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a111">TEXT_ATTR_INVALID</a> = ATK_TEXT_ATTR_INVALID,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a112">TEXT_ATTR_LEFT_MARGIN</a> = ATK_TEXT_ATTR_LEFT_MARGIN,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a113">TEXT_ATTR_RIGHT_MARGIN</a> = ATK_TEXT_ATTR_RIGHT_MARGIN,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a114">TEXT_ATTR_INDENT</a> = ATK_TEXT_ATTR_INDENT,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a115">TEXT_ATTR_INVISIBLE</a> = ATK_TEXT_ATTR_INVISIBLE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a116">TEXT_ATTR_EDITABLE</a> = ATK_TEXT_ATTR_EDITABLE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a117">TEXT_ATTR_PIXELS_ABOVE_LINES</a> = ATK_TEXT_ATTR_PIXELS_ABOVE_LINES,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a118">TEXT_ATTR_PIXELS_BELOW_LINES</a> = ATK_TEXT_ATTR_PIXELS_BELOW_LINES,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a119">TEXT_ATTR_PIXELS_INSIDE_WRAP</a> = ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a120">TEXT_ATTR_BG_FULL_HEIGHT</a> = ATK_TEXT_ATTR_BG_FULL_HEIGHT,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a121">TEXT_ATTR_RISE</a> = ATK_TEXT_ATTR_RISE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a122">TEXT_ATTR_UNDERLINE</a> = ATK_TEXT_ATTR_UNDERLINE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a123">TEXT_ATTR_STRIKETHROUGH</a> = ATK_TEXT_ATTR_STRIKETHROUGH,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a124">TEXT_ATTR_SIZE</a> = ATK_TEXT_ATTR_SIZE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a125">TEXT_ATTR_SCALE</a> = ATK_TEXT_ATTR_SCALE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a126">TEXT_ATTR_WEIGHT</a> = ATK_TEXT_ATTR_WEIGHT,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a127">TEXT_ATTR_LANGUAGE</a> = ATK_TEXT_ATTR_LANGUAGE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a128">TEXT_ATTR_FAMILY_NAME</a> = ATK_TEXT_ATTR_FAMILY_NAME,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a129">TEXT_ATTR_BG_COLOR</a> = ATK_TEXT_ATTR_BG_COLOR,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a130">TEXT_ATTR_FG_COLOR</a> = ATK_TEXT_ATTR_FG_COLOR,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a131">TEXT_ATTR_BG_STIPPLE</a> = ATK_TEXT_ATTR_BG_STIPPLE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a132">TEXT_ATTR_FG_STIPPLE</a> = ATK_TEXT_ATTR_FG_STIPPLE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a133">TEXT_ATTR_WRAP_MODE</a> = ATK_TEXT_ATTR_WRAP_MODE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a134">TEXT_ATTR_DIRECTION</a> = ATK_TEXT_ATTR_DIRECTION,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a135">TEXT_ATTR_JUSTIFICATION</a> = ATK_TEXT_ATTR_JUSTIFICATION,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a136">TEXT_ATTR_STRETCH</a> = ATK_TEXT_ATTR_STRETCH,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a137">TEXT_ATTR_VARIANT</a> = ATK_TEXT_ATTR_VARIANT,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a138">TEXT_ATTR_STYLE</a> = ATK_TEXT_ATTR_STYLE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a197a139">TEXT_ATTR_LAST_DEFINED</a> = ATK_TEXT_ATTR_LAST_DEFINED
<br>
}
<dl class="el"><dd class="mdescRight">Describes the text attributes supported. <a href="#a197">More...</a><br></dl><li>enum <a class="el" href="namespaceGFC_1_1Atk.html#a198">TextBoundary</a> { <br>
<a class="el" href="namespaceGFC_1_1Atk.html#a198a140">TEXT_BOUNDARY_CHAR</a> = ATK_TEXT_BOUNDARY_CHAR,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a198a141">TEXT_BOUNDARY_WORD_START</a> = ATK_TEXT_BOUNDARY_WORD_START,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a198a142">TEXT_BOUNDARY_WORD_END</a> = ATK_TEXT_BOUNDARY_WORD_END,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a198a143">TEXT_BOUNDARY_SENTENCE_START</a> = ATK_TEXT_BOUNDARY_SENTENCE_START,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a198a144">TEXT_BOUNDARY_SENTENCE_END</a> = ATK_TEXT_BOUNDARY_SENTENCE_END,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a198a145">TEXT_BOUNDARY_LINE_START</a> = ATK_TEXT_BOUNDARY_LINE_START,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a198a146">TEXT_BOUNDARY_LINE_END</a> = ATK_TEXT_BOUNDARY_LINE_END
<br>
}
<dl class="el"><dd class="mdescRight">Specifies text boundary types to use when retrieving regions of text with get_text_after_offset(), get_text_at_offset() and get_text_before_offset(). <a href="#a198">More...</a><br></dl><li>enum <a class="el" href="namespaceGFC_1_1Atk.html#a199">TextClipType</a> { <br>
<a class="el" href="namespaceGFC_1_1Atk.html#a199a147">TEXT_CLIP_NONE</a> = ATK_TEXT_CLIP_NONE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a199a148">TEXT_CLIP_MIN</a> = ATK_TEXT_CLIP_MIN,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a199a149">TEXT_CLIP_MAX</a> = ATK_TEXT_CLIP_MAX,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a199a150">ATK_TEXT_CLIP_BOTH</a> = TEXT_CLIP_MAX
<br>
}
<dl class="el"><dd class="mdescRight">Describes the type of clipping required. <a href="#a199">More...</a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An AtkText C++ wrapper interface.
<p>
Provides Text, an interface implemented by components with text content.<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="a197" doxytag="text.hh::TextAttribute" ></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"> enum <a class="el" href="namespaceGFC_1_1Atk.html#a197">TextAttribute</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Describes the text attributes supported.
<p>
Where appropriate each TextAttribute type lists all the possible values, in index order. The first value is 0, the second value is 1, and so on. This is the index you need to specify when constructing an <a class="el" href="classGFC_1_1Atk_1_1Attribute.html">Attribute</a>. For example, for boolean values "false" is 0 and "true" is 1. For wrap mode "none" is 0, "char" is 1, and "word" is 2. You should be able to work the rest out. <dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a197a111" doxytag="TEXT_ATTR_INVALID" ></a>TEXT_ATTR_INVALID</em> </td><td>
Invalid attribute. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a112" doxytag="TEXT_ATTR_LEFT_MARGIN" ></a>TEXT_ATTR_LEFT_MARGIN</em> </td><td>
The pixel width of the left margin. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a113" doxytag="TEXT_ATTR_RIGHT_MARGIN" ></a>TEXT_ATTR_RIGHT_MARGIN</em> </td><td>
The pixel width of the right margin. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a114" doxytag="TEXT_ATTR_INDENT" ></a>TEXT_ATTR_INDENT</em> </td><td>
The number of pixels that the text is indented. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a115" doxytag="TEXT_ATTR_INVISIBLE" ></a>TEXT_ATTR_INVISIBLE</em> </td><td>
Either "false" or "true" indicating whether text is visible or not. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a116" doxytag="TEXT_ATTR_EDITABLE" ></a>TEXT_ATTR_EDITABLE</em> </td><td>
Either "false" or "true" indicating whether text is editable or not. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a117" doxytag="TEXT_ATTR_PIXELS_ABOVE_LINES" ></a>TEXT_ATTR_PIXELS_ABOVE_LINES</em> </td><td>
Pixels of blank space to leave above each newline-terminated line. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a118" doxytag="TEXT_ATTR_PIXELS_BELOW_LINES" ></a>TEXT_ATTR_PIXELS_BELOW_LINES</em> </td><td>
Pixels of blank space to leave below each newline-terminated line. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a119" doxytag="TEXT_ATTR_PIXELS_INSIDE_WRAP" ></a>TEXT_ATTR_PIXELS_INSIDE_WRAP</em> </td><td>
Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph). </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a120" doxytag="TEXT_ATTR_BG_FULL_HEIGHT" ></a>TEXT_ATTR_BG_FULL_HEIGHT</em> </td><td>
Either false" or "true" indicating whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a121" doxytag="TEXT_ATTR_RISE" ></a>TEXT_ATTR_RISE</em> </td><td>
Number of pixels that the characters are risen above the baseline. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a122" doxytag="TEXT_ATTR_UNDERLINE" ></a>TEXT_ATTR_UNDERLINE</em> </td><td>
The underline style, either "none", "single", "double" or "low". </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a123" doxytag="TEXT_ATTR_STRIKETHROUGH" ></a>TEXT_ATTR_STRIKETHROUGH</em> </td><td>
Either "false" or "true" indicating whether the text is struck-through. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a124" doxytag="TEXT_ATTR_SIZE" ></a>TEXT_ATTR_SIZE</em> </td><td>
The size of the characters. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a125" doxytag="TEXT_ATTR_SCALE" ></a>TEXT_ATTR_SCALE</em> </td><td>
A string representation of a double indicating the scale of the characters. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a126" doxytag="TEXT_ATTR_WEIGHT" ></a>TEXT_ATTR_WEIGHT</em> </td><td>
The weight of the characters. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a127" doxytag="TEXT_ATTR_LANGUAGE" ></a>TEXT_ATTR_LANGUAGE</em> </td><td>
The language used. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a128" doxytag="TEXT_ATTR_FAMILY_NAME" ></a>TEXT_ATTR_FAMILY_NAME</em> </td><td>
The font family name. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a129" doxytag="TEXT_ATTR_BG_COLOR" ></a>TEXT_ATTR_BG_COLOR</em> </td><td>
The background color; an RGB value of the format "%u,%u,%u". </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a130" doxytag="TEXT_ATTR_FG_COLOR" ></a>TEXT_ATTR_FG_COLOR</em> </td><td>
The foreground color; an RGB value of the format "%u,%u,%u". </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a131" doxytag="TEXT_ATTR_BG_STIPPLE" ></a>TEXT_ATTR_BG_STIPPLE</em> </td><td>
Either "false" or "true" indicating if a <a class="el" href="classGFC_1_1Gdk_1_1Bitmap.html">Gdk::Bitmap</a> is set for stippling the background color. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a132" doxytag="TEXT_ATTR_FG_STIPPLE" ></a>TEXT_ATTR_FG_STIPPLE</em> </td><td>
Either "false" or "true" indicating if a <a class="el" href="classGFC_1_1Gdk_1_1Bitmap.html">Gdk::Bitmap</a> is set for stippling the foreground color. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a133" doxytag="TEXT_ATTR_WRAP_MODE" ></a>TEXT_ATTR_WRAP_MODE</em> </td><td>
The wrap mode of the text, if any; possible values are "none", "char" or "word". </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a134" doxytag="TEXT_ATTR_DIRECTION" ></a>TEXT_ATTR_DIRECTION</em> </td><td>
The direction of the text, if set; possible values are "none", "ltr" or "rtl". </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a135" doxytag="TEXT_ATTR_JUSTIFICATION" ></a>TEXT_ATTR_JUSTIFICATION</em> </td><td>
The justification of the text, if set; possible values are "left", "right", "center" or "fill". </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a136" doxytag="TEXT_ATTR_STRETCH" ></a>TEXT_ATTR_STRETCH</em> </td><td>
The stretch of the text, if set; possible values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" or "ultra_expanded". </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a137" doxytag="TEXT_ATTR_VARIANT" ></a>TEXT_ATTR_VARIANT</em> </td><td>
The capitalization variant of the text, if set; possible values are "normal" or "small_caps". </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a138" doxytag="TEXT_ATTR_STYLE" ></a>TEXT_ATTR_STYLE</em> </td><td>
The slant style of the text, if set; possible values are "normal", "oblique" or "italic". </td></tr>
<tr><td valign=top><em><a class="anchor" name="a197a139" doxytag="TEXT_ATTR_LAST_DEFINED" ></a>TEXT_ATTR_LAST_DEFINED</em> </td><td>
Not a valid text attribute, used for finding the end of the enumeration. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a198" doxytag="text.hh::TextBoundary" ></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"> enum <a class="el" href="namespaceGFC_1_1Atk.html#a198">TextBoundary</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Specifies text boundary types to use when retrieving regions of text with get_text_after_offset(), get_text_at_offset() and get_text_before_offset().
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a198a140" doxytag="TEXT_BOUNDARY_CHAR" ></a>TEXT_BOUNDARY_CHAR</em> </td><td>
Use character boundaries. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a198a141" doxytag="TEXT_BOUNDARY_WORD_START" ></a>TEXT_BOUNDARY_WORD_START</em> </td><td>
Use word start boundaries. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a198a142" doxytag="TEXT_BOUNDARY_WORD_END" ></a>TEXT_BOUNDARY_WORD_END</em> </td><td>
Use word end boundaries. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a198a143" doxytag="TEXT_BOUNDARY_SENTENCE_START" ></a>TEXT_BOUNDARY_SENTENCE_START</em> </td><td>
Use sentence start boundaries. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a198a144" doxytag="TEXT_BOUNDARY_SENTENCE_END" ></a>TEXT_BOUNDARY_SENTENCE_END</em> </td><td>
Use sentence end boundaries. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a198a145" doxytag="TEXT_BOUNDARY_LINE_START" ></a>TEXT_BOUNDARY_LINE_START</em> </td><td>
Use line start boundaries. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a198a146" doxytag="TEXT_BOUNDARY_LINE_END" ></a>TEXT_BOUNDARY_LINE_END</em> </td><td>
Use line end boundaries. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a199" doxytag="text.hh::TextClipType" ></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"> enum <a class="el" href="namespaceGFC_1_1Atk.html#a199">TextClipType</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Describes the type of clipping required.
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a199a147" doxytag="TEXT_CLIP_NONE" ></a>TEXT_CLIP_NONE</em> </td><td>
No clipping to be done. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a199a148" doxytag="TEXT_CLIP_MIN" ></a>TEXT_CLIP_MIN</em> </td><td>
<a class="el" href="classGFC_1_1Atk_1_1Text.html">Text</a> clipped by min coordinate is omitted. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a199a149" doxytag="TEXT_CLIP_MAX" ></a>TEXT_CLIP_MAX</em> </td><td>
<a class="el" href="classGFC_1_1Atk_1_1Text.html">Text</a> clipped by max coordinate is omitted. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a199a150" doxytag="ATK_TEXT_CLIP_BOTH" ></a>ATK_TEXT_CLIP_BOTH</em> </td><td>
Only text fully within mix/max bound is retained. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="a185" doxytag="text.hh::text_attribute_for_name" ></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"> <a class="el" href="namespaceGFC_1_1Atk.html#a197">TextAttribute</a> text_attribute_for_name </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname1" valign="top" nowrap> <em>name</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>
Get the TextAttribute type corresponding to a text attribute <em>name</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>name</em> </td><td>A string which is the (non-localized) name of a TextAttribute. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The TextAttribute enumerated type corresponding to the specified name, or TEXT_ATTR_INVALID if no matching text attribute is found. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a184" doxytag="text.hh::text_attribute_get_name" ></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"> String text_attribute_get_name </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Atk.html#a197">TextAttribute</a> </td>
<td class="mdname1" valign="top" nowrap> <em>attr</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>
Gets the name corresponding to the TextAttribute.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>attr</em> </td><td>The TextAttribute whose name is required. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A string containing the name. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a186" doxytag="text.hh::text_attribute_get_value" ></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"> String text_attribute_get_value </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Atk.html#a197">TextAttribute</a> </td>
<td class="mdname" nowrap> <em>attr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>index</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>
Gets the value for the index of the text attribute <em>attr</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>attr</em> </td><td>The TextAttribute for which a value is required. </td></tr>
<tr><td></td><td valign=top><em>index</em> </td><td>The index of the required value. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> containing the value, or a null <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> if there are no values maintained for <em>attr</em>. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a183" doxytag="text.hh::text_attribute_register" ></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"> <a class="el" href="namespaceGFC_1_1Atk.html#a197">TextAttribute</a> text_attribute_register </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname1" valign="top" nowrap> <em>name</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>
Associate name with a new TextAttribute.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>name</em> </td><td>A name string. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The new TextAttribute associated with <em>name</em>. </dd></dl>
</td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:33 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>
|
