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
531
532
533
534
535
536
537
538
539
540
|
<!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::ListboxTextItem 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_1ListboxTextItem.html">ListboxTextItem</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pro-static-attribs">Static Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::ListboxTextItem Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::ListboxTextItem" --><!-- doxytag: inherits="CEGUI::ListboxItem" -->
<p>Class used for textual items in a list box.
<a href="classCEGUI_1_1ListboxTextItem.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::ListboxTextItem:</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_1ListboxTextItem__inherit__graph.gif" border="0" usemap="#CEGUI_1_1ListboxTextItem_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1ListboxTextItem_inherit__map" id="CEGUI_1_1ListboxTextItem_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items." alt="" coords="17,5,159,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::ListboxTextItem:</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_1ListboxTextItem__coll__graph.gif" border="0" usemap="#CEGUI_1_1ListboxTextItem_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1ListboxTextItem_coll__map" id="CEGUI_1_1ListboxTextItem_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items." alt="" coords="5,5,147,35"/><area shape="rect" id="node4" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities." alt="" coords="171,5,333,35"/><area shape="rect" id="node6" href="classCEGUI_1_1Font.html" title="Class that encapsulates a typeface." alt="" coords="357,5,456,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1ListboxTextItem-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="aac9c8a9f6542e3441689ce2b515ff3e8"></a><!-- doxytag: member="CEGUI::ListboxTextItem::ListboxTextItem" ref="aac9c8a9f6542e3441689ce2b515ff3e8" args="(const String &text, uint item_id=0, void *item_data=0, bool disabled=false, bool auto_delete=true)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxTextItem.html#aac9c8a9f6542e3441689ce2b515ff3e8">ListboxTextItem</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &text, uint item_id=0, void *item_data=0, bool disabled=false, bool auto_delete=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">base class constructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a4235bff205daf9af69d6b0a8f79ec4"></a><!-- doxytag: member="CEGUI::ListboxTextItem::~ListboxTextItem" ref="a1a4235bff205daf9af69d6b0a8f79ec4" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxTextItem.html#a1a4235bff205daf9af69d6b0a8f79ec4">~ListboxTextItem</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">base class destructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Font.html">Font</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxTextItem.html#a8c581b17acc13db4fc7a95ccb13240f6">getFont</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the font being used by this <a class="el" href="classCEGUI_1_1ListboxTextItem.html" title="Class used for textual items in a list box.">ListboxTextItem</a>. <a href="#a8c581b17acc13db4fc7a95ccb13240f6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxTextItem.html#ab4c2a6da64c42f519ed75d515992114d">getTextColours</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current colours used for text rendering. <a href="#ab4c2a6da64c42f519ed75d515992114d"></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_1ListboxTextItem.html#ae583db5db204264f76418dfe56441a3e">setFont</a> (<a class="el" href="classCEGUI_1_1Font.html">Font</a> *font)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the font to be used by this <a class="el" href="classCEGUI_1_1ListboxTextItem.html" title="Class used for textual items in a list box.">ListboxTextItem</a>. <a href="#ae583db5db204264f76418dfe56441a3e"></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_1ListboxTextItem.html#a7970a013804fdf3f32a5181193bf8335">setFont</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &font_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the font to be used by this <a class="el" href="classCEGUI_1_1ListboxTextItem.html" title="Class used for textual items in a list box.">ListboxTextItem</a>. <a href="#a7970a013804fdf3f32a5181193bf8335"></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_1ListboxTextItem.html#a3a3e5e1defdb358a5c5202259cd2cff7">setTextColours</a> (const <a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> &cols)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the colours used for text rendering. <a href="#a3a3e5e1defdb358a5c5202259cd2cff7"></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_1ListboxTextItem.html#aa4fa51a8d32ba70620011b89096bd078">setTextColours</a> (<a class="el" href="classCEGUI_1_1colour.html">colour</a> top_left_colour, <a class="el" href="classCEGUI_1_1colour.html">colour</a> top_right_colour, <a class="el" href="classCEGUI_1_1colour.html">colour</a> bottom_left_colour, <a class="el" href="classCEGUI_1_1colour.html">colour</a> bottom_right_colour)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the colours used for text rendering. <a href="#aa4fa51a8d32ba70620011b89096bd078"></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_1ListboxTextItem.html#a5fb0c1f6756792bfbfc0e46f934e664e">setTextColours</a> (<a class="el" href="classCEGUI_1_1colour.html">colour</a> col)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the colours used for text rendering. <a href="#a5fb0c1f6756792bfbfc0e46f934e664e"></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_1ListboxTextItem.html#a93b3b42c93421f26f9b23854cfac5c27">setTextParsingEnabled</a> (const bool enable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set whether the the <a class="el" href="classCEGUI_1_1ListboxTextItem.html" title="Class used for textual items in a list box.">ListboxTextItem</a> will have it's text parsed via the <a class="el" href="classCEGUI_1_1BasicRenderedStringParser.html" title="Basic RenderedStringParser class that offers support for the following tags:">BasicRenderedStringParser</a> or not. <a href="#a93b3b42c93421f26f9b23854cfac5c27"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a655cee1bebe20d7716517e98ebbd486a"></a><!-- doxytag: member="CEGUI::ListboxTextItem::isTextParsingEnabled" ref="a655cee1bebe20d7716517e98ebbd486a" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxTextItem.html#a655cee1bebe20d7716517e98ebbd486a">isTextParsingEnabled</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return whether text parsing is enabled for this <a class="el" href="classCEGUI_1_1ListboxTextItem.html" title="Class used for textual items in a list box.">ListboxTextItem</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_1ListboxTextItem.html#a660c8196d672798ebc8e457678d7d89d">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 string for this list box item. <a href="#a660c8196d672798ebc8e457678d7d89d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Size.html">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxTextItem.html#aa64ec8e3095abb3a7a79730bf10f6307">getPixelSize</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the rendered pixel size of this list box item. <a href="#aa64ec8e3095abb3a7a79730bf10f6307"></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_1ListboxTextItem.html#afa288957245fc5c777ce83a0da939797">draw</a> (<a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> &buffer, const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> &targetRect, float alpha, const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> *clipper) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Draw the list box item in its current state. <a href="#afa288957245fc5c777ce83a0da939797"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34ad76a2b4e2fae0a3303a61601787d6"></a><!-- doxytag: member="CEGUI::ListboxTextItem::DefaultTextColour" ref="a34ad76a2b4e2fae0a3303a61601787d6" args="" -->
static const <a class="el" href="classCEGUI_1_1colour.html">colour</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxTextItem.html#a34ad76a2b4e2fae0a3303a61601787d6">DefaultTextColour</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default text colour. <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="ac9c5e1637fcef2558292b15c7267316a"></a><!-- doxytag: member="CEGUI::ListboxTextItem::parseTextString" ref="ac9c5e1637fcef2558292b15c7267316a" args="() const " -->
void </td><td class="memItemRight" valign="bottom"><b>parseTextString</b> () const </td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8fbf4d29e55b5e21987ce39ce4e0da1c"></a><!-- doxytag: member="CEGUI::ListboxTextItem::d_textCols" ref="a8fbf4d29e55b5e21987ce39ce4e0da1c" args="" -->
<a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxTextItem.html#a8fbf4d29e55b5e21987ce39ce4e0da1c">d_textCols</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Colours used for rendering the text. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Font.html">Font</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxTextItem.html#ab33e6e2530afe8f2049c77fa582c98ab">d_font</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37e1e4c27fe2f439dccc14ec0c4a46b3"></a><!-- doxytag: member="CEGUI::ListboxTextItem::d_renderedString" ref="a37e1e4c27fe2f439dccc14ec0c4a46b3" args="" -->
<a class="el" href="classCEGUI_1_1RenderedString.html">RenderedString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxTextItem.html#a37e1e4c27fe2f439dccc14ec0c4a46b3">d_renderedString</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a> drawn by this item. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac96861a8ad2d0b9fc7c8b81c6c09e248"></a><!-- doxytag: member="CEGUI::ListboxTextItem::d_renderedStringValid" ref="ac96861a8ad2d0b9fc7c8b81c6c09e248" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxTextItem.html#ac96861a8ad2d0b9fc7c8b81c6c09e248">d_renderedStringValid</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">boolean used to track when item state changes (and needs re-parse) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab80e0aa70b0961c6a006e5b7c73dcf05"></a><!-- doxytag: member="CEGUI::ListboxTextItem::d_textParsingEnabled" ref="ab80e0aa70b0961c6a006e5b7c73dcf05" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxTextItem.html#ab80e0aa70b0961c6a006e5b7c73dcf05">d_textParsingEnabled</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">boolean that specifies whether text parsing is enabled for the item. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a339b740cb31243c89c0be1ea3a9f3a59"></a><!-- doxytag: member="CEGUI::ListboxTextItem::d_stringParser" ref="a339b740cb31243c89c0be1ea3a9f3a59" args="" -->
static <a class="el" href="classCEGUI_1_1BasicRenderedStringParser.html">BasicRenderedStringParser</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxTextItem.html#a339b740cb31243c89c0be1ea3a9f3a59">d_stringParser</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parser used to produce a final <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a> from the standard <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83651de6ce465d9cec473d5905d2e3c5"></a><!-- doxytag: member="CEGUI::ListboxTextItem::d_noTagsStringParser" ref="a83651de6ce465d9cec473d5905d2e3c5" args="" -->
static <a class="el" href="classCEGUI_1_1DefaultRenderedStringParser.html">DefaultRenderedStringParser</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxTextItem.html#a83651de6ce465d9cec473d5905d2e3c5">d_noTagsStringParser</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parser used when parsing is off. Basically just does linebreaks. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class used for textual items in a list box. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afa288957245fc5c777ce83a0da939797"></a><!-- doxytag: member="CEGUI::ListboxTextItem::draw" ref="afa288957245fc5c777ce83a0da939797" args="(GeometryBuffer &buffer, const Rect &targetRect, float alpha, const Rect *clipper) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxTextItem::draw </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> & </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> & </td>
<td class="paramname"><em>targetRect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>alpha</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> * </td>
<td class="paramname"><em>clipper</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draw the list box item in its current state. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>Vecor2 object describing the upper-left corner of area that should be rendered in to for the draw operation.</td></tr>
<tr><td class="paramname">alpha</td><td>Alpha value to be used when rendering the item (between 0.0f and 1.0f).</td></tr>
<tr><td class="paramname">clipper</td><td><a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing the clipping rectangle for the draw operation.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1ListboxItem.html#a881f2b1b9e1c37f2f52a72dffdcf2ad9">CEGUI::ListboxItem</a>.</p>
</div>
</div>
<a class="anchor" id="a8c581b17acc13db4fc7a95ccb13240f6"></a><!-- doxytag: member="CEGUI::ListboxTextItem::getFont" ref="a8c581b17acc13db4fc7a95ccb13240f6" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Font.html">Font</a>* CEGUI::ListboxTextItem::getFont </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a pointer to the font being used by this <a class="el" href="classCEGUI_1_1ListboxTextItem.html" title="Class used for textual items in a list box.">ListboxTextItem</a>. </p>
<p>This method will try a number of places to find a font to be used. If no font can be found, NULL is returned.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Font.html" title="Class that encapsulates a typeface.">Font</a> to be used for rendering this item </dd></dl>
</div>
</div>
<a class="anchor" id="aa64ec8e3095abb3a7a79730bf10f6307"></a><!-- doxytag: member="CEGUI::ListboxTextItem::getPixelSize" ref="aa64ec8e3095abb3a7a79730bf10f6307" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Size.html">Size</a> CEGUI::ListboxTextItem::getPixelSize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the rendered pixel size of this list box item. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> object describing the size of the list box item in pixels. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1ListboxItem.html#a77d2f1b9678dda2c4d5a45c6f61d53b9">CEGUI::ListboxItem</a>.</p>
</div>
</div>
<a class="anchor" id="ab4c2a6da64c42f519ed75d515992114d"></a><!-- doxytag: member="CEGUI::ListboxTextItem::getTextColours" ref="ab4c2a6da64c42f519ed75d515992114d" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> CEGUI::ListboxTextItem::getTextColours </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the current colours used for text rendering. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a> object describing the currently set colours </dd></dl>
</div>
</div>
<a class="anchor" id="a7970a013804fdf3f32a5181193bf8335"></a><!-- doxytag: member="CEGUI::ListboxTextItem::setFont" ref="a7970a013804fdf3f32a5181193bf8335" args="(const String &font_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxTextItem::setFont </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>font_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the font to be used by this <a class="el" href="classCEGUI_1_1ListboxTextItem.html" title="Class used for textual items in a list box.">ListboxTextItem</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">font_name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the <a class="el" href="classCEGUI_1_1Font.html" title="Class that encapsulates a typeface.">Font</a> to be used for rendering this item</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
</div>
</div>
<a class="anchor" id="ae583db5db204264f76418dfe56441a3e"></a><!-- doxytag: member="CEGUI::ListboxTextItem::setFont" ref="ae583db5db204264f76418dfe56441a3e" args="(Font *font)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxTextItem::setFont </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1Font.html">Font</a> * </td>
<td class="paramname"><em>font</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the font to be used by this <a class="el" href="classCEGUI_1_1ListboxTextItem.html" title="Class used for textual items in a list box.">ListboxTextItem</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td><a class="el" href="classCEGUI_1_1Font.html" title="Class that encapsulates a typeface.">Font</a> to be used for rendering this item</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
</div>
</div>
<a class="anchor" id="a660c8196d672798ebc8e457678d7d89d"></a><!-- doxytag: member="CEGUI::ListboxTextItem::setText" ref="a660c8196d672798ebc8e457678d7d89d" args="(const String &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxTextItem::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><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set the text string for this list box item. </p>
<p>Note that even if the item does not render text, the text string can still be useful, since it is used for sorting list box items.</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> object containing the text to set for the list box item.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1ListboxItem.html#a0dc25b57b0c14ab5a4a80d885a06156a">CEGUI::ListboxItem</a>.</p>
</div>
</div>
<a class="anchor" id="aa4fa51a8d32ba70620011b89096bd078"></a><!-- doxytag: member="CEGUI::ListboxTextItem::setTextColours" ref="aa4fa51a8d32ba70620011b89096bd078" args="(colour top_left_colour, colour top_right_colour, colour bottom_left_colour, colour bottom_right_colour)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxTextItem::setTextColours </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1colour.html">colour</a> </td>
<td class="paramname"><em>top_left_colour</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1colour.html">colour</a> </td>
<td class="paramname"><em>top_right_colour</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1colour.html">colour</a> </td>
<td class="paramname"><em>bottom_left_colour</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1colour.html">colour</a> </td>
<td class="paramname"><em>bottom_right_colour</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the colours used for text rendering. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">top_left_colour</td><td>Colour (as ARGB value) to be applied to the top-left corner of each text glyph rendered.</td></tr>
<tr><td class="paramname">top_right_colour</td><td>Colour (as ARGB value) to be applied to the top-right corner of each text glyph rendered.</td></tr>
<tr><td class="paramname">bottom_left_colour</td><td>Colour (as ARGB value) to be applied to the bottom-left corner of each text glyph rendered.</td></tr>
<tr><td class="paramname">bottom_right_colour</td><td>Colour (as ARGB value) to be applied to the bottom-right corner of each text glyph rendered.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a3a3e5e1defdb358a5c5202259cd2cff7"></a><!-- doxytag: member="CEGUI::ListboxTextItem::setTextColours" ref="a3a3e5e1defdb358a5c5202259cd2cff7" args="(const ColourRect &cols)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxTextItem::setTextColours </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> & </td>
<td class="paramname"><em>cols</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the colours used for text rendering. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cols</td><td><a class="el" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a> object describing the colours to be used.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a5fb0c1f6756792bfbfc0e46f934e664e"></a><!-- doxytag: member="CEGUI::ListboxTextItem::setTextColours" ref="a5fb0c1f6756792bfbfc0e46f934e664e" args="(colour col)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxTextItem::setTextColours </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1colour.html">colour</a> </td>
<td class="paramname"><em>col</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the colours used for text rendering. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">col</td><td>colour value to be used when rendering.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>References <a class="el" href="classCEGUI_1_1ListboxTextItem.html#a5fb0c1f6756792bfbfc0e46f934e664e">setTextColours()</a>.</p>
<p>Referenced by <a class="el" href="classCEGUI_1_1ListboxTextItem.html#a5fb0c1f6756792bfbfc0e46f934e664e">setTextColours()</a>.</p>
</div>
</div>
<a class="anchor" id="a93b3b42c93421f26f9b23854cfac5c27"></a><!-- doxytag: member="CEGUI::ListboxTextItem::setTextParsingEnabled" ref="a93b3b42c93421f26f9b23854cfac5c27" args="(const bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxTextItem::setTextParsingEnabled </td>
<td>(</td>
<td class="paramtype">const bool </td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set whether the the <a class="el" href="classCEGUI_1_1ListboxTextItem.html" title="Class used for textual items in a list box.">ListboxTextItem</a> will have it's text parsed via the <a class="el" href="classCEGUI_1_1BasicRenderedStringParser.html" title="Basic RenderedStringParser class that offers support for the following tags:">BasicRenderedStringParser</a> or not. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">enable</td><td><ul>
<li>true if the <a class="el" href="classCEGUI_1_1ListboxTextItem.html" title="Class used for textual items in a list box.">ListboxTextItem</a> text will be parsed.</li>
<li>false if the <a class="el" href="classCEGUI_1_1ListboxTextItem.html" title="Class used for textual items in a list box.">ListboxTextItem</a> text will be used verbatim. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ab33e6e2530afe8f2049c77fa582c98ab"></a><!-- doxytag: member="CEGUI::ListboxTextItem::d_font" ref="ab33e6e2530afe8f2049c77fa582c98ab" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Font.html">Font</a>* <a class="el" href="classCEGUI_1_1ListboxTextItem.html#ab33e6e2530afe8f2049c77fa582c98ab">CEGUI::ListboxTextItem::d_font</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Font.html" title="Class that encapsulates a typeface.">Font</a> used for rendering text. </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 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>
|
