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
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
|
<!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::ListboxItem 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_1ListboxItem.html">ListboxItem</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> </div>
<div class="headertitle">
<div class="title">CEGUI::ListboxItem Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::ListboxItem" -->
<p>Base class for list box items.
<a href="classCEGUI_1_1ListboxItem.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::ListboxItem:</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_1ListboxItem__inherit__graph.gif" border="0" usemap="#CEGUI_1_1ListboxItem_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1ListboxItem_inherit__map" id="CEGUI_1_1ListboxItem_inherit__map">
<area shape="rect" id="node3" href="classCEGUI_1_1ListboxTextItem.html" title="Class used for textual items in a list box." alt="" coords="5,83,171,112"/></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::ListboxItem:</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_1ListboxItem__coll__graph.gif" border="0" usemap="#CEGUI_1_1ListboxItem_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1ListboxItem_coll__map" id="CEGUI_1_1ListboxItem_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle." alt="" coords="5,104,144,133"/><area shape="rect" id="node4" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="188,5,295,35"/><area shape="rect" id="node6" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset." alt="" coords="293,104,403,133"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1ListboxItem-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="a604ef49cc1e6a3f1f66c000449f3d0c1"></a><!-- doxytag: member="CEGUI::ListboxItem::ListboxItem" ref="a604ef49cc1e6a3f1f66c000449f3d0c1" 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_1ListboxItem.html#a604ef49cc1e6a3f1f66c000449f3d0c1">ListboxItem</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="a30cf4c0acb1531c2bddd78da82184e9c"></a><!-- doxytag: member="CEGUI::ListboxItem::~ListboxItem" ref="a30cf4c0acb1531c2bddd78da82184e9c" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#a30cf4c0acb1531c2bddd78da82184e9c">~ListboxItem</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">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#ae4e0a1e7bd53cbeae61095a6a335bd20">getTooltipText</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the text string set for this list box item. <a href="#ae4e0a1e7bd53cbeae61095a6a335bd20"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ac53f86a974115f89c0ce2eee559ccc"></a><!-- doxytag: member="CEGUI::ListboxItem::getText" ref="a0ac53f86a974115f89c0ce2eee559ccc" args="(void) const " -->
const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><b>getText</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaeebe03952494e263b61196a8ee9f262"></a><!-- doxytag: member="CEGUI::ListboxItem::getTextVisual" ref="aaeebe03952494e263b61196a8ee9f262" 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_1ListboxItem.html#aaeebe03952494e263b61196a8ee9f262">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">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#a5fb43d99ffd068192e8c1d11b41cc76c">getID</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current ID assigned to this list box item. <a href="#a5fb43d99ffd068192e8c1d11b41cc76c"></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_1ListboxItem.html#a73b3eba79727d9421c555e4fad3ace09">getUserData</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the pointer to any client assigned user data attached to this lis box item. <a href="#a73b3eba79727d9421c555e4fad3ace09"></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_1ListboxItem.html#ab6bf0f9e5cdf062ab5e377ebb92e474a">isSelected</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return whether this item is selected. <a href="#ab6bf0f9e5cdf062ab5e377ebb92e474a"></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_1ListboxItem.html#a4c2d6bca2ec1a67154c8e310b0a7c463">isDisabled</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return whether this item is disabled. <a href="#a4c2d6bca2ec1a67154c8e310b0a7c463"></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_1ListboxItem.html#acd4ae4d5e27eee5427bbb8aa690b0c9f">isAutoDeleted</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return whether this item will be automatically deleted when the list box it is attached to is destroyed, or when the item is removed from the list box. <a href="#acd4ae4d5e27eee5427bbb8aa690b0c9f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1Window.html">Window</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#aea71b777f899e46c3e661ddd3cdae342">getOwnerWindow</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the owner window for this <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a>. <a href="#aea71b777f899e46c3e661ddd3cdae342"></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_1ListboxItem.html#a93f63a0926916d4e64c142b8f2e5e4ab">getSelectionColours</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current colours used for selection highlighting. <a href="#a93f63a0926916d4e64c142b8f2e5e4ab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1Image.html">Image</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#a9380149c63c805bc3bd0cbf4727384cd">getSelectionBrushImage</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current selection highlighting brush. <a href="#a9380149c63c805bc3bd0cbf4727384cd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#a0dc25b57b0c14ab5a4a80d885a06156a">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="#a0dc25b57b0c14ab5a4a80d885a06156a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb7b5669aa11ed4dc8f0f0d8f1d34673"></a><!-- doxytag: member="CEGUI::ListboxItem::setTooltipText" ref="acb7b5669aa11ed4dc8f0f0d8f1d34673" args="(const String &text)" -->
void </td><td class="memItemRight" valign="bottom"><b>setTooltipText</b> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &text)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#a07e9f5502dd7d4898312a80072fcfc94">setID</a> (uint item_id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the ID assigned to this list box item. <a href="#a07e9f5502dd7d4898312a80072fcfc94"></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_1ListboxItem.html#a258bf3f1b91fe4ab151d0d2d86e0a16f">setUserData</a> (void *item_data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the client assigned user data attached to this lis box item. <a href="#a258bf3f1b91fe4ab151d0d2d86e0a16f"></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_1ListboxItem.html#a43f3a158bf94eae61eba38a37bb93ffb">setSelected</a> (bool setting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set whether this item is selected. <a href="#a43f3a158bf94eae61eba38a37bb93ffb"></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_1ListboxItem.html#ab794b8a6268da1093d6dfc24c0877859">setDisabled</a> (bool setting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set whether this item is disabled. <a href="#ab794b8a6268da1093d6dfc24c0877859"></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_1ListboxItem.html#a9cae53680f6066a54f63ce97d24a2102">setAutoDeleted</a> (bool setting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set whether this item will be automatically deleted when the list box it is attached to is destroyed, or when the item is removed from the list box. <a href="#a9cae53680f6066a54f63ce97d24a2102"></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_1ListboxItem.html#ac0da9f81a9f8c24c3569ffe6823a9b36">setOwnerWindow</a> (const <a class="el" href="classCEGUI_1_1Window.html">Window</a> *owner)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the owner window for this <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a>. This is called by all the list box widgets when an item is added or inserted. <a href="#ac0da9f81a9f8c24c3569ffe6823a9b36"></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_1ListboxItem.html#a0484157b7bdf6c25754680697b2fce90">setSelectionColours</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 selection highlighting. <a href="#a0484157b7bdf6c25754680697b2fce90"></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_1ListboxItem.html#a74f433e675b25c9e385437e63d4a9601">setSelectionColours</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 selection highlighting. <a href="#a74f433e675b25c9e385437e63d4a9601"></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_1ListboxItem.html#a44095b87351c64f9a21698417f6cd1c4">setSelectionColours</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 selection highlighting. <a href="#a44095b87351c64f9a21698417f6cd1c4"></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_1ListboxItem.html#a7268ca25103f32cce34568ccda344e97">setSelectionBrushImage</a> (const <a class="el" href="classCEGUI_1_1Image.html">Image</a> *image)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the selection highlighting brush image. <a href="#a7268ca25103f32cce34568ccda344e97"></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_1ListboxItem.html#a36f487e77299475c1e4e61489b9b3e4b">setSelectionBrushImage</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &imageset, const <a class="el" href="classCEGUI_1_1String.html">String</a> &image)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the selection highlighting brush image. <a href="#a36f487e77299475c1e4e61489b9b3e4b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1Size.html">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#a77d2f1b9678dda2c4d5a45c6f61d53b9">getPixelSize</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the rendered pixel size of this list box item. <a href="#a77d2f1b9678dda2c4d5a45c6f61d53b9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#a881f2b1b9e1c37f2f52a72dffdcf2ad9">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 =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Draw the list box item in its current state. <a href="#a881f2b1b9e1c37f2f52a72dffdcf2ad9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8eac1f792aba3c5d44acf3a2f83ac084"></a><!-- doxytag: member="CEGUI::ListboxItem::operator<" ref="a8eac1f792aba3c5d44acf3a2f83ac084" args="(const ListboxItem &rhs) const " -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#a8eac1f792aba3c5d44acf3a2f83ac084">operator<</a> (const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Less-than operator, compares item texts. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a374cd6df6cb39ced7aa2f51635a250e3"></a><!-- doxytag: member="CEGUI::ListboxItem::operator>" ref="a374cd6df6cb39ced7aa2f51635a250e3" args="(const ListboxItem &rhs) const " -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#a374cd6df6cb39ced7aa2f51635a250e3">operator></a> (const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Greater-than operator, compares item texts. <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="a646ad1c262e2c8368422e234b6241826"></a><!-- doxytag: member="CEGUI::ListboxItem::DefaultSelectionColour" ref="a646ad1c262e2c8368422e234b6241826" 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_1ListboxItem.html#a646ad1c262e2c8368422e234b6241826">DefaultSelectionColour</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default selection brush 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="ae54e47f57982f4f66cce56a5532ae267"></a><!-- doxytag: member="CEGUI::ListboxItem::getModulateAlphaColourRect" ref="ae54e47f57982f4f66cce56a5532ae267" args="(const ColourRect &cols, float alpha) const " -->
<a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#ae54e47f57982f4f66cce56a5532ae267">getModulateAlphaColourRect</a> (const <a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> &cols, float alpha) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a <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 in <em>cols</em> after having their alpha component modulated by the value <em>alpha</em>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb862a5d91d9b0614dabe1ccf261a3b8"></a><!-- doxytag: member="CEGUI::ListboxItem::calculateModulatedAlphaColour" ref="acb862a5d91d9b0614dabe1ccf261a3b8" args="(colour col, float alpha) const " -->
<a class="el" href="classCEGUI_1_1colour.html">colour</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#acb862a5d91d9b0614dabe1ccf261a3b8">calculateModulatedAlphaColour</a> (<a class="el" href="classCEGUI_1_1colour.html">colour</a> col, float alpha) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a colour value describing the colour specified by <em>col</em> after having its alpha component modulated by the value <em>alpha</em>. <br/></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="ac6fe83a715fd25e77a4381db612763e1"></a><!-- doxytag: member="CEGUI::ListboxItem::d_textLogical" ref="ac6fe83a715fd25e77a4381db612763e1" args="" -->
<a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>d_textLogical</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad366e6d5a5a4b7466860176e375cf703"></a><!-- doxytag: member="CEGUI::ListboxItem::d_bidiVisualMapping" ref="ad366e6d5a5a4b7466860176e375cf703" args="" -->
<a class="el" href="classCEGUI_1_1BiDiVisualMapping.html">BiDiVisualMapping</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#ad366e6d5a5a4b7466860176e375cf703">d_bidiVisualMapping</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">pointer to bidirection support object <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a405fdf1331078876d4109df92fcb0f2f"></a><!-- doxytag: member="CEGUI::ListboxItem::d_bidiDataValid" ref="a405fdf1331078876d4109df92fcb0f2f" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#a405fdf1331078876d4109df92fcb0f2f">d_bidiDataValid</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">whether bidi visual mapping has been updated since last text change. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48c29c6d8eec69a540ee9f9f0d939b9d"></a><!-- doxytag: member="CEGUI::ListboxItem::d_tooltipText" ref="a48c29c6d8eec69a540ee9f9f0d939b9d" args="" -->
<a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#a48c29c6d8eec69a540ee9f9f0d939b9d">d_tooltipText</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Text for the individual tooltip of this item. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a643f4b953b68a941262cc75edd803c"></a><!-- doxytag: member="CEGUI::ListboxItem::d_itemID" ref="a9a643f4b953b68a941262cc75edd803c" args="" -->
uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#a9a643f4b953b68a941262cc75edd803c">d_itemID</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">ID code assigned by client code. This has no meaning within the GUI system. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57fcfcaad41983ad35e1941365a850a4"></a><!-- doxytag: member="CEGUI::ListboxItem::d_itemData" ref="a57fcfcaad41983ad35e1941365a850a4" args="" -->
void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#a57fcfcaad41983ad35e1941365a850a4">d_itemData</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to some client code data. This has no meaning within the GUI system. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af59c0d29275c5750d081d4e6f102b2bf"></a><!-- doxytag: member="CEGUI::ListboxItem::d_selected" ref="af59c0d29275c5750d081d4e6f102b2bf" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#af59c0d29275c5750d081d4e6f102b2bf">d_selected</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if this item is selected. false if the item is not selected. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb26e775a068b37b811ab3c81615be5c"></a><!-- doxytag: member="CEGUI::ListboxItem::d_disabled" ref="abb26e775a068b37b811ab3c81615be5c" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#abb26e775a068b37b811ab3c81615be5c">d_disabled</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if this item is disabled. false if the item is not disabled. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adff46b14a860da44ed92afe7211a4cfa"></a><!-- doxytag: member="CEGUI::ListboxItem::d_autoDelete" ref="adff46b14a860da44ed92afe7211a4cfa" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#adff46b14a860da44ed92afe7211a4cfa">d_autoDelete</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if the system should destroy this item, false if client code will destroy the item. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f5a7f3e36a622cc5817b68c46676a9c"></a><!-- doxytag: member="CEGUI::ListboxItem::d_owner" ref="a1f5a7f3e36a622cc5817b68c46676a9c" args="" -->
const <a class="el" href="classCEGUI_1_1Window.html">Window</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#a1f5a7f3e36a622cc5817b68c46676a9c">d_owner</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the window that owns this item. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c901a2731c648a9d0074c2d9d108af5"></a><!-- doxytag: member="CEGUI::ListboxItem::d_selectCols" ref="a6c901a2731c648a9d0074c2d9d108af5" args="" -->
<a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#a6c901a2731c648a9d0074c2d9d108af5">d_selectCols</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Colours used for selection highlighting. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa59d9fd4e1de7fe5fd67b36c97c6872e"></a><!-- doxytag: member="CEGUI::ListboxItem::d_selectBrush" ref="aa59d9fd4e1de7fe5fd67b36c97c6872e" args="" -->
const <a class="el" href="classCEGUI_1_1Image.html">Image</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ListboxItem.html#aa59d9fd4e1de7fe5fd67b36c97c6872e">d_selectBrush</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset.">Image</a> used for rendering selection. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class for list box items. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a881f2b1b9e1c37f2f52a72dffdcf2ad9"></a><!-- doxytag: member="CEGUI::ListboxItem::draw" ref="a881f2b1b9e1c37f2f52a72dffdcf2ad9" args="(GeometryBuffer &buffer, const Rect &targetRect, float alpha, const Rect *clipper) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ListboxItem::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> [pure 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>Implemented in <a class="el" href="classCEGUI_1_1ListboxTextItem.html#afa288957245fc5c777ce83a0da939797">CEGUI::ListboxTextItem</a>.</p>
</div>
</div>
<a class="anchor" id="a5fb43d99ffd068192e8c1d11b41cc76c"></a><!-- doxytag: member="CEGUI::ListboxItem::getID" ref="a5fb43d99ffd068192e8c1d11b41cc76c" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint CEGUI::ListboxItem::getID </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 ID assigned to this list box item. </p>
<p>Note that the system does not make use of this value, client code can assign any meaning it wishes to the ID.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>ID code currently assigned to this list box item </dd></dl>
</div>
</div>
<a class="anchor" id="aea71b777f899e46c3e661ddd3cdae342"></a><!-- doxytag: member="CEGUI::ListboxItem::getOwnerWindow" ref="aea71b777f899e46c3e661ddd3cdae342" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1Window.html">Window</a>* CEGUI::ListboxItem::getOwnerWindow </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the owner window for this <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a>. </p>
<p>The owner of a <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> is typically set by the list box widgets when an item is added or inserted.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Ponter to the window that is considered the owner of this <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a77d2f1b9678dda2c4d5a45c6f61d53b9"></a><!-- doxytag: member="CEGUI::ListboxItem::getPixelSize" ref="a77d2f1b9678dda2c4d5a45c6f61d53b9" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCEGUI_1_1Size.html">Size</a> CEGUI::ListboxItem::getPixelSize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure 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>Implemented in <a class="el" href="classCEGUI_1_1ListboxTextItem.html#aa64ec8e3095abb3a7a79730bf10f6307">CEGUI::ListboxTextItem</a>.</p>
</div>
</div>
<a class="anchor" id="a9380149c63c805bc3bd0cbf4727384cd"></a><!-- doxytag: member="CEGUI::ListboxItem::getSelectionBrushImage" ref="a9380149c63c805bc3bd0cbf4727384cd" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1Image.html">Image</a>* CEGUI::ListboxItem::getSelectionBrushImage </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 selection highlighting brush. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the <a class="el" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset.">Image</a> object currently used for selection highlighting. </dd></dl>
</div>
</div>
<a class="anchor" id="a93f63a0926916d4e64c142b8f2e5e4ab"></a><!-- doxytag: member="CEGUI::ListboxItem::getSelectionColours" ref="a93f63a0926916d4e64c142b8f2e5e4ab" 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::ListboxItem::getSelectionColours </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 selection highlighting. </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="ae4e0a1e7bd53cbeae61095a6a335bd20"></a><!-- doxytag: member="CEGUI::ListboxItem::getTooltipText" ref="ae4e0a1e7bd53cbeae61095a6a335bd20" args="(void) 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::ListboxItem::getTooltipText </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 text string set 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 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 current text for the list box item. </dd></dl>
</div>
</div>
<a class="anchor" id="a73b3eba79727d9421c555e4fad3ace09"></a><!-- doxytag: member="CEGUI::ListboxItem::getUserData" ref="a73b3eba79727d9421c555e4fad3ace09" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* CEGUI::ListboxItem::getUserData </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 pointer to any client assigned user data attached to this lis box item. </p>
<p>Note that the system does not make use of this data, client code can assign any meaning it wishes to the attached data.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the currently assigned user data. </dd></dl>
</div>
</div>
<a class="anchor" id="acd4ae4d5e27eee5427bbb8aa690b0c9f"></a><!-- doxytag: member="CEGUI::ListboxItem::isAutoDeleted" ref="acd4ae4d5e27eee5427bbb8aa690b0c9f" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::ListboxItem::isAutoDeleted </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 whether this item will be automatically deleted when the list box it is attached to is destroyed, or when the item is removed from the list box. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the item object will be deleted by the system when the list box it is attached to is destroyed, or when the item is removed from the list. false if client code must destroy the item after it is removed from the list. </dd></dl>
</div>
</div>
<a class="anchor" id="a4c2d6bca2ec1a67154c8e310b0a7c463"></a><!-- doxytag: member="CEGUI::ListboxItem::isDisabled" ref="a4c2d6bca2ec1a67154c8e310b0a7c463" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::ListboxItem::isDisabled </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 whether this item is disabled. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the item is disabled, false if the item is enabled. </dd></dl>
</div>
</div>
<a class="anchor" id="ab6bf0f9e5cdf062ab5e377ebb92e474a"></a><!-- doxytag: member="CEGUI::ListboxItem::isSelected" ref="ab6bf0f9e5cdf062ab5e377ebb92e474a" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::ListboxItem::isSelected </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 whether this item is selected. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the item is selected, false if the item is not selected. </dd></dl>
</div>
</div>
<a class="anchor" id="a9cae53680f6066a54f63ce97d24a2102"></a><!-- doxytag: member="CEGUI::ListboxItem::setAutoDeleted" ref="a9cae53680f6066a54f63ce97d24a2102" args="(bool setting)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxItem::setAutoDeleted </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>setting</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set whether this item will be automatically deleted when the list box it is attached to is destroyed, or when the item is removed from the list box. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">setting</td><td>true if the item object should be deleted by the system when the list box it is attached to is destroyed, or when the item is removed from the list. false if client code will destroy the item after it is removed from the list.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="ab794b8a6268da1093d6dfc24c0877859"></a><!-- doxytag: member="CEGUI::ListboxItem::setDisabled" ref="ab794b8a6268da1093d6dfc24c0877859" args="(bool setting)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxItem::setDisabled </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>setting</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set whether this item is disabled. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">setting</td><td>true if the item is disabled, false if the item is enabled.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a07e9f5502dd7d4898312a80072fcfc94"></a><!-- doxytag: member="CEGUI::ListboxItem::setID" ref="a07e9f5502dd7d4898312a80072fcfc94" args="(uint item_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxItem::setID </td>
<td>(</td>
<td class="paramtype">uint </td>
<td class="paramname"><em>item_id</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the ID assigned to this list box item. </p>
<p>Note that the system does not make use of this value, client code can assign any meaning it wishes to the ID.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">item_id</td><td>ID code to be assigned to this list box item</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="ac0da9f81a9f8c24c3569ffe6823a9b36"></a><!-- doxytag: member="CEGUI::ListboxItem::setOwnerWindow" ref="ac0da9f81a9f8c24c3569ffe6823a9b36" args="(const Window *owner)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxItem::setOwnerWindow </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Window.html">Window</a> * </td>
<td class="paramname"><em>owner</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the owner window for this <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a>. This is called by all the list box widgets when an item is added or inserted. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">owner</td><td>Ponter to the window that should be considered the owner of this <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
</div>
</div>
<a class="anchor" id="a43f3a158bf94eae61eba38a37bb93ffb"></a><!-- doxytag: member="CEGUI::ListboxItem::setSelected" ref="a43f3a158bf94eae61eba38a37bb93ffb" args="(bool setting)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxItem::setSelected </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>setting</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set whether this item is selected. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">setting</td><td>true if the item is selected, false if the item is not selected.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a7268ca25103f32cce34568ccda344e97"></a><!-- doxytag: member="CEGUI::ListboxItem::setSelectionBrushImage" ref="a7268ca25103f32cce34568ccda344e97" args="(const Image *image)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxItem::setSelectionBrushImage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Image.html">Image</a> * </td>
<td class="paramname"><em>image</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the selection highlighting brush image. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>Pointer to the <a class="el" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset.">Image</a> object to be used for selection highlighting.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a36f487e77299475c1e4e61489b9b3e4b"></a><!-- doxytag: member="CEGUI::ListboxItem::setSelectionBrushImage" ref="a36f487e77299475c1e4e61489b9b3e4b" args="(const String &imageset, const String &image)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxItem::setSelectionBrushImage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>imageset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>image</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the selection highlighting brush image. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">imageset</td><td>Name of the imagest containing the image to be used.</td></tr>
<tr><td class="paramname">image</td><td>Name of the image 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="a74f433e675b25c9e385437e63d4a9601"></a><!-- doxytag: member="CEGUI::ListboxItem::setSelectionColours" ref="a74f433e675b25c9e385437e63d4a9601" 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::ListboxItem::setSelectionColours </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 selection highlighting. </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 the selection area.</td></tr>
<tr><td class="paramname">top_right_colour</td><td>Colour (as ARGB value) to be applied to the top-right corner of the selection area.</td></tr>
<tr><td class="paramname">bottom_left_colour</td><td>Colour (as ARGB value) to be applied to the bottom-left corner of the selection area.</td></tr>
<tr><td class="paramname">bottom_right_colour</td><td>Colour (as ARGB value) to be applied to the bottom-right corner of the selection area.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a0484157b7bdf6c25754680697b2fce90"></a><!-- doxytag: member="CEGUI::ListboxItem::setSelectionColours" ref="a0484157b7bdf6c25754680697b2fce90" args="(const ColourRect &cols)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxItem::setSelectionColours </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 selection highlighting. </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="a44095b87351c64f9a21698417f6cd1c4"></a><!-- doxytag: member="CEGUI::ListboxItem::setSelectionColours" ref="a44095b87351c64f9a21698417f6cd1c4" args="(colour col)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxItem::setSelectionColours </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 selection highlighting. </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_1ListboxItem.html#a44095b87351c64f9a21698417f6cd1c4">setSelectionColours()</a>.</p>
<p>Referenced by <a class="el" href="classCEGUI_1_1ListboxItem.html#a44095b87351c64f9a21698417f6cd1c4">setSelectionColours()</a>.</p>
</div>
</div>
<a class="anchor" id="a0dc25b57b0c14ab5a4a80d885a06156a"></a><!-- doxytag: member="CEGUI::ListboxItem::setText" ref="a0dc25b57b0c14ab5a4a80d885a06156a" args="(const String &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ListboxItem::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 in <a class="el" href="classCEGUI_1_1ListboxTextItem.html#a660c8196d672798ebc8e457678d7d89d">CEGUI::ListboxTextItem</a>.</p>
</div>
</div>
<a class="anchor" id="a258bf3f1b91fe4ab151d0d2d86e0a16f"></a><!-- doxytag: member="CEGUI::ListboxItem::setUserData" ref="a258bf3f1b91fe4ab151d0d2d86e0a16f" args="(void *item_data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ListboxItem::setUserData </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>item_data</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the client assigned user data attached to this lis box item. </p>
<p>Note that the system does not make use of this data, client code can assign any meaning it wishes to the attached data.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">item_data</td><td>Pointer to the user data to attach to this list item.</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: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>
|
