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
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::TextComponent Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1TextComponent.html">TextComponent</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::TextComponent Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::TextComponent" --><!-- doxytag: inherits="CEGUI::FalagardComponentBase" -->
<p>Class that encapsulates information for a text component.
<a href="classCEGUI_1_1TextComponent.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::TextComponent:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1TextComponent__inherit__graph.gif" border="0" usemap="#CEGUI_1_1TextComponent_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1TextComponent_inherit__map" id="CEGUI_1_1TextComponent_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1FalagardComponentBase.html" title="Common base class used for renderable components within an ImagerySection." alt="" coords="5,5,224,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::TextComponent:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1TextComponent__coll__graph.gif" border="0" usemap="#CEGUI_1_1TextComponent_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1TextComponent_coll__map" id="CEGUI_1_1TextComponent_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1FalagardComponentBase.html" title="Common base class used for renderable components within an ImagerySection." alt="" coords="152,156,371,185"/><area shape="rect" id="node4" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="28,5,135,35"/><area shape="rect" id="node6" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities." alt="" coords="395,156,557,185"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1TextComponent-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a887f41152cb4dc2073dc53ca3758522e"></a><!-- doxytag: member="CEGUI::TextComponent::TextComponent" ref="a887f41152cb4dc2073dc53ca3758522e" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a887f41152cb4dc2073dc53ca3758522e">TextComponent</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5986423f44317b0ed076b62e80eed2e6"></a><!-- doxytag: member="CEGUI::TextComponent::~TextComponent" ref="a5986423f44317b0ed076b62e80eed2e6" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a5986423f44317b0ed076b62e80eed2e6">~TextComponent</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afcf81eafeefa93cb3d6f61ca30ff22de"></a><!-- doxytag: member="CEGUI::TextComponent::TextComponent" ref="afcf81eafeefa93cb3d6f61ca30ff22de" args="(const TextComponent &obj)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#afcf81eafeefa93cb3d6f61ca30ff22de">TextComponent</a> (const <a class="el" href="classCEGUI_1_1TextComponent.html">TextComponent</a> &obj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91339044430104aa5e3a417eae068fea"></a><!-- doxytag: member="CEGUI::TextComponent::operator=" ref="a91339044430104aa5e3a417eae068fea" args="(const TextComponent &other)" -->
<a class="el" href="classCEGUI_1_1TextComponent.html">TextComponent</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a91339044430104aa5e3a417eae068fea">operator=</a> (const <a class="el" href="classCEGUI_1_1TextComponent.html">TextComponent</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a1ee27f4da8230cc513fe13b013eba7b9">getText</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the text object that will be rendered by this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. <a href="#a1ee27f4da8230cc513fe13b013eba7b9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8ac510d30dd0fbeb9cdf472ca743e84a"></a><!-- doxytag: member="CEGUI::TextComponent::getTextVisual" ref="a8ac510d30dd0fbeb9cdf472ca743e84a" args="() const " -->
const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a8ac510d30dd0fbeb9cdf472ca743e84a">getTextVisual</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return text string with <em>visual</em> ordering of glyphs. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a3206f974f49bb7021ebf425f0e3745cd">setText</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the text that will be rendered by this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. <a href="#a3206f974f49bb7021ebf425f0e3745cd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a512f2f3767cd7c1ae010c8ec1b0ee95c">getFont</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the font to be used when rendering this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. <a href="#a512f2f3767cd7c1ae010c8ec1b0ee95c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#aeadc35717f3728fd210b25d0a9deec43">setFont</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &font)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the font to be used when rendering this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. <a href="#aeadc35717f3728fd210b25d0a9deec43"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCEGUI.html#a19b33cf5bc5472259c143edbc3d77079">VerticalTextFormatting</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#ab43ef231efaecf11ef13f0060171488b">getVerticalFormatting</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current vertical formatting setting for this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. <a href="#ab43ef231efaecf11ef13f0060171488b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a7831eae11d5d05ea35f538de90ae4afd">setVerticalFormatting</a> (<a class="el" href="namespaceCEGUI.html#a19b33cf5bc5472259c143edbc3d77079">VerticalTextFormatting</a> fmt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the vertical formatting setting for this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. <a href="#a7831eae11d5d05ea35f538de90ae4afd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCEGUI.html#a379719d009ffa73a87100bb8b0b6fe5b">HorizontalTextFormatting</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a68b5a093abc159479cd9936b731b2ab0">getHorizontalFormatting</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current horizontal formatting setting for this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. <a href="#a68b5a093abc159479cd9936b731b2ab0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a7183aa25bfeca14fb31efb449d0fea35">setHorizontalFormatting</a> (<a class="el" href="namespaceCEGUI.html#a379719d009ffa73a87100bb8b0b6fe5b">HorizontalTextFormatting</a> fmt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the horizontal formatting setting for this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. <a href="#a7183aa25bfeca14fb31efb449d0fea35"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#ab2ca2c92bebd384b026e2f20e2246d5c">writeXMLToStream</a> (<a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> &xml_stream) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes an xml representation of this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a> to <em>out_stream</em>. <a href="#ab2ca2c92bebd384b026e2f20e2246d5c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a175a048bb3b44462eb5fe02e68b8b300">isTextFetchedFromProperty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a> fetches it's text string via a property on the target window. <a href="#a175a048bb3b44462eb5fe02e68b8b300"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#ae0acd58c7f687c20caae34e055b5f359">getTextPropertySource</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the property that will be used to determine the text string to render for this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. <a href="#ae0acd58c7f687c20caae34e055b5f359"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#ab558220a97b77dec3f50e2566cbc648d">setTextPropertySource</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &property)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the property that will be used to determine the text string to render for this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. <a href="#ab558220a97b77dec3f50e2566cbc648d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#adc165e8e949fbd51cb982421529d21f0">isFontFetchedFromProperty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a> fetches it's font via a property on the target window. <a href="#adc165e8e949fbd51cb982421529d21f0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#af20863f433c931fccfc95f0d3c46f45e">getFontPropertySource</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the property that will be used to determine the font to use for rendering the text string for this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. <a href="#af20863f433c931fccfc95f0d3c46f45e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a6fc5274e3ce6aa219d7e9727e3c26984">setFontPropertySource</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &property)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the property that will be used to determine the font to use for rendering the text string of this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. <a href="#a6fc5274e3ce6aa219d7e9727e3c26984"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a722de028f945d7f26165b8ed8cee3d3b"></a><!-- doxytag: member="CEGUI::TextComponent::getHorizontalTextExtent" ref="a722de028f945d7f26165b8ed8cee3d3b" args="() const " -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a722de028f945d7f26165b8ed8cee3d3b">getHorizontalTextExtent</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the horizontal pixel extent of the formatted rendered string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7db3ad681ca2203018b9485b7d7c2c69"></a><!-- doxytag: member="CEGUI::TextComponent::getVerticalTextExtent" ref="a7db3ad681ca2203018b9485b7d7c2c69" args="() const " -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a7db3ad681ca2203018b9485b7d7c2c69">getVerticalTextExtent</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the vertical pixel extent of the formatted rendered string. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38313480808538252137ae1ddcafd9d4"></a><!-- doxytag: member="CEGUI::TextComponent::render_impl" ref="a38313480808538252137ae1ddcafd9d4" args="(Window &srcWindow, Rect &destRect, const CEGUI::ColourRect *modColours, const Rect *clipper, bool clipToDisplay) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a38313480808538252137ae1ddcafd9d4">render_impl</a> (<a class="el" href="classCEGUI_1_1Window.html">Window</a> &srcWindow, <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> &destRect, const <a class="el" href="classCEGUI_1_1ColourRect.html">CEGUI::ColourRect</a> *modColours, const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> *clipper, bool clipToDisplay) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Method to do main render caching work. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c7d6224b6a37de2068135d29f9d5c6b"></a><!-- doxytag: member="CEGUI::TextComponent::setupStringFormatter" ref="a9c7d6224b6a37de2068135d29f9d5c6b" args="(const Window &window, const RenderedString &rendered_string) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextComponent.html#a9c7d6224b6a37de2068135d29f9d5c6b">setupStringFormatter</a> (const <a class="el" href="classCEGUI_1_1Window.html">Window</a> &window, const <a class="el" href="classCEGUI_1_1RenderedString.html">RenderedString</a> &rendered_string) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">helper to set up an appropriate <a class="el" href="classCEGUI_1_1FormattedRenderedString.html" title="Root of a class hierarchy that wrap RenderedString objects and render them with additional formatting...">FormattedRenderedString</a> <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class that encapsulates information for a text component. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a512f2f3767cd7c1ae010c8ec1b0ee95c"></a><!-- doxytag: member="CEGUI::TextComponent::getFont" ref="a512f2f3767cd7c1ae010c8ec1b0ee95c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::TextComponent::getFont </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the name of the font to be used when rendering this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of a font, or "" if the window font is to be used. </dd></dl>
</div>
</div>
<a class="anchor" id="af20863f433c931fccfc95f0d3c46f45e"></a><!-- doxytag: member="CEGUI::TextComponent::getFontPropertySource" ref="af20863f433c931fccfc95f0d3c46f45e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::TextComponent::getFontPropertySource </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the name of the property that will be used to determine the font to use for rendering the text string for this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of a Propery. </dd></dl>
</div>
</div>
<a class="anchor" id="a68b5a093abc159479cd9936b731b2ab0"></a><!-- doxytag: member="CEGUI::TextComponent::getHorizontalFormatting" ref="a68b5a093abc159479cd9936b731b2ab0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceCEGUI.html#a379719d009ffa73a87100bb8b0b6fe5b">HorizontalTextFormatting</a> CEGUI::TextComponent::getHorizontalFormatting </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the current horizontal formatting setting for this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the HorizontalTextFormatting enumerated values. </dd></dl>
</div>
</div>
<a class="anchor" id="a1ee27f4da8230cc513fe13b013eba7b9"></a><!-- doxytag: member="CEGUI::TextComponent::getText" ref="a1ee27f4da8230cc513fe13b013eba7b9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::TextComponent::getText </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the text object that will be rendered by this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the text that will be rendered. </dd></dl>
</div>
</div>
<a class="anchor" id="ae0acd58c7f687c20caae34e055b5f359"></a><!-- doxytag: member="CEGUI::TextComponent::getTextPropertySource" ref="ae0acd58c7f687c20caae34e055b5f359" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::TextComponent::getTextPropertySource </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the name of the property that will be used to determine the text string to render for this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of a Propery. </dd></dl>
</div>
</div>
<a class="anchor" id="ab43ef231efaecf11ef13f0060171488b"></a><!-- doxytag: member="CEGUI::TextComponent::getVerticalFormatting" ref="ab43ef231efaecf11ef13f0060171488b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceCEGUI.html#a19b33cf5bc5472259c143edbc3d77079">VerticalTextFormatting</a> CEGUI::TextComponent::getVerticalFormatting </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the current vertical formatting setting for this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the VerticalTextFormatting enumerated values. </dd></dl>
</div>
</div>
<a class="anchor" id="adc165e8e949fbd51cb982421529d21f0"></a><!-- doxytag: member="CEGUI::TextComponent::isFontFetchedFromProperty" ref="adc165e8e949fbd51cb982421529d21f0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::TextComponent::isFontFetchedFromProperty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a> fetches it's font via a property on the target window. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the font comes via a Propery.</li>
<li>false if the font is defined explicitly, or will come from the target window. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a175a048bb3b44462eb5fe02e68b8b300"></a><!-- doxytag: member="CEGUI::TextComponent::isTextFetchedFromProperty" ref="a175a048bb3b44462eb5fe02e68b8b300" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::TextComponent::isTextFetchedFromProperty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a> fetches it's text string via a property on the target window. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the text string comes via a Propery.</li>
<li>false if the text string is defined explicitly, or will come from the target window. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="aeadc35717f3728fd210b25d0a9deec43"></a><!-- doxytag: member="CEGUI::TextComponent::setFont" ref="aeadc35717f3728fd210b25d0a9deec43" args="(const String &font)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::TextComponent::setFont </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>font</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the name of the font to be used when rendering this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. </p>
<p>Note that setting this to the empty string ("") will cause the font from the base window passed when rendering to be used instead.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing name of a font</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a6fc5274e3ce6aa219d7e9727e3c26984"></a><!-- doxytag: member="CEGUI::TextComponent::setFontPropertySource" ref="a6fc5274e3ce6aa219d7e9727e3c26984" args="(const String &property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::TextComponent::setFontPropertySource </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>property</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the name of the property that will be used to determine the font to use for rendering the text string of this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">property</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of a Propery. The property should access a valid font name.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a7183aa25bfeca14fb31efb449d0fea35"></a><!-- doxytag: member="CEGUI::TextComponent::setHorizontalFormatting" ref="a7183aa25bfeca14fb31efb449d0fea35" args="(HorizontalTextFormatting fmt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::TextComponent::setHorizontalFormatting </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCEGUI.html#a379719d009ffa73a87100bb8b0b6fe5b">HorizontalTextFormatting</a> </td>
<td class="paramname"><em>fmt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the horizontal formatting setting for this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>One of the HorizontalTextFormatting enumerated values.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a3206f974f49bb7021ebf425f0e3745cd"></a><!-- doxytag: member="CEGUI::TextComponent::setText" ref="a3206f974f49bb7021ebf425f0e3745cd" args="(const String &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::TextComponent::setText </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the text that will be rendered by this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. </p>
<p>Note that setting this to the empty string ("") will cause the text from the base window passed when rendering to be used instead.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing text to render, or "" to render text from window.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="ab558220a97b77dec3f50e2566cbc648d"></a><!-- doxytag: member="CEGUI::TextComponent::setTextPropertySource" ref="ab558220a97b77dec3f50e2566cbc648d" args="(const String &property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::TextComponent::setTextPropertySource </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>property</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the name of the property that will be used to determine the text string to render for this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">property</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of a Propery. The property can contain any text string to render.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a7831eae11d5d05ea35f538de90ae4afd"></a><!-- doxytag: member="CEGUI::TextComponent::setVerticalFormatting" ref="a7831eae11d5d05ea35f538de90ae4afd" args="(VerticalTextFormatting fmt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::TextComponent::setVerticalFormatting </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCEGUI.html#a19b33cf5bc5472259c143edbc3d77079">VerticalTextFormatting</a> </td>
<td class="paramname"><em>fmt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the vertical formatting setting for this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>One of the VerticalTextFormatting enumerated values.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="ab2ca2c92bebd384b026e2f20e2246d5c"></a><!-- doxytag: member="CEGUI::TextComponent::writeXMLToStream" ref="ab2ca2c92bebd384b026e2f20e2246d5c" args="(XMLSerializer &xml_stream) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::TextComponent::writeXMLToStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> & </td>
<td class="paramname"><em>xml_stream</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes an xml representation of this <a class="el" href="classCEGUI_1_1TextComponent.html" title="Class that encapsulates information for a text component.">TextComponent</a> to <em>out_stream</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">xml_stream</td><td>Stream where xml data should be output.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
