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
|
<!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::ItemListbox 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_1ItemListbox.html">ItemListbox</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::ItemListbox Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::ItemListbox" --><!-- doxytag: inherits="CEGUI::ScrolledItemListBase" -->
<p><a class="el" href="classCEGUI_1_1ItemListbox.html" title="ItemListbox window class.">ItemListbox</a> window class.
<a href="classCEGUI_1_1ItemListbox.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::ItemListbox:</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_1ItemListbox__inherit__graph.gif" border="0" usemap="#CEGUI_1_1ItemListbox_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1ItemListbox_inherit__map" id="CEGUI_1_1ItemListbox_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ScrolledItemListBase.html" title="ScrolledItemListBase window class." alt="" coords="5,83,203,112"/><area shape="rect" id="node4" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets." alt="" coords="29,5,179,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::ItemListbox:</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_1ItemListbox__coll__graph.gif" border="0" usemap="#CEGUI_1_1ItemListbox_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1ItemListbox_coll__map" id="CEGUI_1_1ItemListbox_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ScrolledItemListBase.html" title="ScrolledItemListBase window class." alt="" coords="217,207,415,236"/><area shape="rect" id="node4" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="223,5,329,35"/><area shape="rect" id="node6" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets." alt="" coords="439,207,569,236"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1ItemListbox-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="a87734b122ff5b0a5ac9308d22de20937"></a><!-- doxytag: member="CEGUI::ItemListbox::getSelectedCount" ref="a87734b122ff5b0a5ac9308d22de20937" args="(void) const " -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#a87734b122ff5b0a5ac9308d22de20937">getSelectedCount</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of selected items in this <a class="el" href="classCEGUI_1_1ItemListbox.html" title="ItemListbox window class.">ItemListbox</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#a5f90715a6622ade8b4c67a2fa577046b">getLastSelectedItem</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the last selected item. <a href="#a5f90715a6622ade8b4c67a2fa577046b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#ad155f50bcbe757d7dd58cdeaa27c5a7f">getFirstSelectedItem</a> (size_t start_index=0) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the first selected item. <a href="#ad155f50bcbe757d7dd58cdeaa27c5a7f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#a5b38803828d2b3fae6b7a25b8e838194">getNextSelectedItem</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the next seleced item relative to a previous call to getFirstSelectedItem or getNextSelectedItem. <a href="#a5b38803828d2b3fae6b7a25b8e838194"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#a07c3a404747d121fd2b0ac842cab68e8">getNextSelectedItemAfter</a> (const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> *start_item) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the next selected item after the item 'start_item' given. <a href="#a07c3a404747d121fd2b0ac842cab68e8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a216888f5b7d9831ee31b9e020032bac3"></a><!-- doxytag: member="CEGUI::ItemListbox::isMultiSelectEnabled" ref="a216888f5b7d9831ee31b9e020032bac3" args="(void) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#a216888f5b7d9831ee31b9e020032bac3">isMultiSelectEnabled</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns 'true' if multiple selections are allowed. 'false' if not. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afbbc42cd032799b86b7df65a49c38f7e"></a><!-- doxytag: member="CEGUI::ItemListbox::isItemSelected" ref="afbbc42cd032799b86b7df65a49c38f7e" args="(size_t index) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#afbbc42cd032799b86b7df65a49c38f7e">isItemSelected</a> (size_t index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns 'true' if the item at the given index is selectable and currently selected. <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_1ItemListbox.html#a7ff27cd96add3373ac69fe7b08ca4f38">initialiseComponents</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialise the <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> based object ready for use. <a href="#a7ff27cd96add3373ac69fe7b08ca4f38"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9cc024ed394bcc3c7dc5d3a1aed3bb09"></a><!-- doxytag: member="CEGUI::ItemListbox::setMultiSelectEnabled" ref="a9cc024ed394bcc3c7dc5d3a1aed3bb09" args="(bool state)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#a9cc024ed394bcc3c7dc5d3a1aed3bb09">setMultiSelectEnabled</a> (bool state)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set whether or not multiple selections should be allowed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7076b3dfa8f508bf97c73709710bff8"></a><!-- doxytag: member="CEGUI::ItemListbox::clearAllSelections" ref="ac7076b3dfa8f508bf97c73709710bff8" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#ac7076b3dfa8f508bf97c73709710bff8">clearAllSelections</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clears all selections. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#ac799eff23e26ea4bf882e9740e75ceb3">selectRange</a> (size_t a, size_t z)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Select a range of items. <a href="#ac799eff23e26ea4bf882e9740e75ceb3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a951b30b957f0aaab0cee292d2b51d855"></a><!-- doxytag: member="CEGUI::ItemListbox::selectAllItems" ref="a951b30b957f0aaab0cee292d2b51d855" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#a951b30b957f0aaab0cee292d2b51d855">selectAllItems</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Select all items. Does nothing if multiselect is disabled. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06aad81af1486fd2ec32d960796e853d"></a><!-- doxytag: member="CEGUI::ItemListbox::ItemListbox" ref="a06aad81af1486fd2ec32d960796e853d" args="(const String &type, const String &name)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#a06aad81af1486fd2ec32d960796e853d">ItemListbox</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &type, const <a class="el" href="classCEGUI_1_1String.html">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for the <a class="el" href="classCEGUI_1_1ItemListbox.html" title="ItemListbox window class.">ItemListbox</a> base class constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf209591b1e78ad8a60271f8a6e5e991"></a><!-- doxytag: member="CEGUI::ItemListbox::~ItemListbox" ref="abf209591b1e78ad8a60271f8a6e5e991" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#abf209591b1e78ad8a60271f8a6e5e991">~ItemListbox</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for the <a class="el" href="classCEGUI_1_1ItemListbox.html" title="ItemListbox window class.">ItemListbox</a> base class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a632c4cfb9665fdcef81d78e46d90fd36"></a><!-- doxytag: member="CEGUI::ItemListbox::layoutItemWidgets" ref="a632c4cfb9665fdcef81d78e46d90fd36" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#a632c4cfb9665fdcef81d78e46d90fd36">layoutItemWidgets</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Setup size and position for the item widgets attached to this <a class="el" href="classCEGUI_1_1ItemListbox.html" title="ItemListbox window class.">ItemListbox</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b8d9b09809eba41dfa5216e1dd91cb1"></a><!-- doxytag: member="CEGUI::ItemListbox::getContentSize" ref="a8b8d9b09809eba41dfa5216e1dd91cb1" args="() const " -->
virtual <a class="el" href="classCEGUI_1_1Size.html">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#a8b8d9b09809eba41dfa5216e1dd91cb1">getContentSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> in unclipped pixels of the content attached to this <a class="el" href="classCEGUI_1_1ItemListbox.html" title="ItemListbox window class.">ItemListbox</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#a11c85f7abb6010a055e928ae2c5f9645">testClassName_impl</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &class_name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. <a href="#a11c85f7abb6010a055e928ae2c5f9645"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb98f248736e56d0e658aef11350f1a5"></a><!-- doxytag: member="CEGUI::ItemListbox::notifyItemClicked" ref="afb98f248736e56d0e658aef11350f1a5" args="(ItemEntry *li)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#afb98f248736e56d0e658aef11350f1a5">notifyItemClicked</a> (<a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> *li)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Notify this <a class="el" href="classCEGUI_1_1ItemListbox.html" title="ItemListbox window class.">ItemListbox</a> that the given ListItem was just clicked. Internal function - not to be used from client code. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c029d11ce76e8f0c01fb347b8fe5815"></a><!-- doxytag: member="CEGUI::ItemListbox::notifyItemSelectState" ref="a2c029d11ce76e8f0c01fb347b8fe5815" args="(ItemEntry *li, bool state)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#a2c029d11ce76e8f0c01fb347b8fe5815">notifyItemSelectState</a> (<a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> *li, bool state)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Notify this <a class="el" href="classCEGUI_1_1ItemListbox.html" title="ItemListbox window class.">ItemListbox</a> that the given ListItem just changed selection state. Internal function - not to be used from client code. <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="abb8406d318fa4cc69c82035f8ce93d5e"></a><!-- doxytag: member="CEGUI::ItemListbox::EventNamespace" ref="abb8406d318fa4cc69c82035f8ce93d5e" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#abb8406d318fa4cc69c82035f8ce93d5e">EventNamespace</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Namespace for global events. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a529a57d389487951679e7bfaebcdf854"></a><!-- doxytag: member="CEGUI::ItemListbox::WidgetTypeName" ref="a529a57d389487951679e7bfaebcdf854" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#a529a57d389487951679e7bfaebcdf854">WidgetTypeName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> factory name. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#adc76148ff60cc5f6403777f90146a81c">EventSelectionChanged</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#a21f6bf383af84a344571fd8a448ec64e">EventMultiSelectModeChanged</a></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="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#ac96e0fd1f638aa8529d923f87addc25f">findSelectedItem</a> (size_t start_index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the first selected item starting the search from <em>start_index</em>. <a href="#ac96e0fd1f638aa8529d923f87addc25f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae31ba9f027e569c2f78fc2431e2f42a6"></a><!-- doxytag: member="CEGUI::ItemListbox::onSelectionChanged" ref="ae31ba9f027e569c2f78fc2431e2f42a6" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>onSelectionChanged</b> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a597ea4042a57d1da88355ffd0c56e987"></a><!-- doxytag: member="CEGUI::ItemListbox::onMultiSelectModeChanged" ref="a597ea4042a57d1da88355ffd0c56e987" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>onMultiSelectModeChanged</b> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#ae8b5cd79102603acac2489d6d675727c">onKeyDown</a> (<a class="el" href="classCEGUI_1_1KeyEventArgs.html">KeyEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called when a key as been depressed while this window has input focus. <a href="#ae8b5cd79102603acac2489d6d675727c"></a><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="ab3b4a856e8c88817bbc88f5a4636eff8"></a><!-- doxytag: member="CEGUI::ItemListbox::d_multiSelect" ref="ab3b4a856e8c88817bbc88f5a4636eff8" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>d_multiSelect</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5e0c4045a7df1cdd38e8f772ea135cd"></a><!-- doxytag: member="CEGUI::ItemListbox::d_lastSelected" ref="af5e0c4045a7df1cdd38e8f772ea135cd" args="" -->
<a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#af5e0c4045a7df1cdd38e8f772ea135cd">d_lastSelected</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Controls whether multiple items can be selected simultaneously. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ea9a01f8c4fcb4197c078badbefa6de"></a><!-- doxytag: member="CEGUI::ItemListbox::d_nextSelectionIndex" ref="a7ea9a01f8c4fcb4197c078badbefa6de" args="" -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListbox.html#a7ea9a01f8c4fcb4197c078badbefa6de">d_nextSelectionIndex</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The last item that was selected. <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="a76b5cfbb672cabb2b15a7f58d1097cb6"></a><!-- doxytag: member="CEGUI::ItemListbox::d_multiSelectProperty" ref="a76b5cfbb672cabb2b15a7f58d1097cb6" args="" -->
static <br class="typebreak"/>
<a class="el" href="classCEGUI_1_1ItemListboxProperties_1_1MultiSelect.html">ItemListboxProperties::MultiSelect</a> </td><td class="memItemRight" valign="bottom"><b>d_multiSelectProperty</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCEGUI_1_1ItemListbox.html" title="ItemListbox window class.">ItemListbox</a> window class. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac96e0fd1f638aa8529d923f87addc25f"></a><!-- doxytag: member="CEGUI::ItemListbox::findSelectedItem" ref="ac96e0fd1f638aa8529d923f87addc25f" args="(size_t start_index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a>* CEGUI::ItemListbox::findSelectedItem </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>start_index</em></td><td>)</td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a pointer to the first selected item starting the search from <em>start_index</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">start_index</td><td>The index where the search should begin (inclusive)</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the first selected item in the listbox found If no item is selected the return value is 0 If <em>start_index</em> is out of bounds the return value is 0</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>This function advances the internal counter and is made for getFirstSelectedItem and getNextSelectedItem </dd></dl>
</div>
</div>
<a class="anchor" id="ad155f50bcbe757d7dd58cdeaa27c5a7f"></a><!-- doxytag: member="CEGUI::ItemListbox::getFirstSelectedItem" ref="ad155f50bcbe757d7dd58cdeaa27c5a7f" args="(size_t start_index=0) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a>* CEGUI::ItemListbox::getFirstSelectedItem </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>start_index</em> = <code>0</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a pointer to the first selected item. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">start_index</td><td>The index where the search should begin. If omitted the search will begin with the first item.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the first selected item in the listbox. If no item is selected the return value is 0. If <em>start_index</em> is out of bounds the return value is 0.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>If multiselect is disabled then this does the equivalent of calling getLastSelectedItem. If multiselect is enabled it will search the array starting at <em>start_index</em> </dd></dl>
</div>
</div>
<a class="anchor" id="a5f90715a6622ade8b4c67a2fa577046b"></a><!-- doxytag: member="CEGUI::ItemListbox::getLastSelectedItem" ref="a5f90715a6622ade8b4c67a2fa577046b" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a>* CEGUI::ItemListbox::getLastSelectedItem </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>Returns a pointer to the last selected item. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the last selected item, 0 is none. </dd></dl>
</div>
</div>
<a class="anchor" id="a5b38803828d2b3fae6b7a25b8e838194"></a><!-- doxytag: member="CEGUI::ItemListbox::getNextSelectedItem" ref="a5b38803828d2b3fae6b7a25b8e838194" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a>* CEGUI::ItemListbox::getNextSelectedItem </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a pointer to the next seleced item relative to a previous call to getFirstSelectedItem or getNextSelectedItem. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the next seleced item. If there are no further selected items the return value is 0. If multiselect is disabled the return value is 0.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>This member function will take on from where the last call to getFirstSelectedItem or getNextSelectedItem returned. So be sure to start with a call to getFirstSelectedItem.</dd></dl>
<p>This member function should be preferred over getNextSelectedItemAfter as it will perform better, especially on large lists. </p>
</div>
</div>
<a class="anchor" id="a07c3a404747d121fd2b0ac842cab68e8"></a><!-- doxytag: member="CEGUI::ItemListbox::getNextSelectedItemAfter" ref="a07c3a404747d121fd2b0ac842cab68e8" args="(const ItemEntry *start_item) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a>* CEGUI::ItemListbox::getNextSelectedItemAfter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td>
<td class="paramname"><em>start_item</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a pointer to the next selected item after the item 'start_item' given. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This member function will search the array from the beginning and will be slow for large lists, it will not advance the internal counter used by getFirstSelectedItem and getNextSelectedItem either. </dd></dl>
</div>
</div>
<a class="anchor" id="a7ff27cd96add3373ac69fe7b08ca4f38"></a><!-- doxytag: member="CEGUI::ItemListbox::initialiseComponents" ref="a7ff27cd96add3373ac69fe7b08ca4f38" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ItemListbox::initialiseComponents </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialise the <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> based object ready for use. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This must be called for every window created. Normally this is handled automatically by the <a class="el" href="classCEGUI_1_1WindowFactory.html" title="Abstract class that defines the required interface for all WindowFactory objects.">WindowFactory</a> for each <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> type.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a8b5cf75ac98200ad3c425589ff6d7d4d">CEGUI::ScrolledItemListBase</a>.</p>
</div>
</div>
<a class="anchor" id="ae8b5cd79102603acac2489d6d675727c"></a><!-- doxytag: member="CEGUI::ItemListbox::onKeyDown" ref="ae8b5cd79102603acac2489d6d675727c" args="(KeyEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ItemListbox::onKeyDown </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1KeyEventArgs.html">KeyEventArgs</a> & </td>
<td class="paramname"><em>e</em></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handler called when a key as been depressed while this window has input focus. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1KeyEventArgs.html" title="EventArgs based class that is used for objects passed to input event handlers concerning keyboard inp...">KeyEventArgs</a> object whose 'scancode' field is set to the Key::Scan value representing the key that was pressed, and whose 'sysKeys' field represents the combination of SystemKey that were active when the event was generated. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#aa69218466130b226e4596428fc0eb60f">CEGUI::Window</a>.</p>
</div>
</div>
<a class="anchor" id="ac799eff23e26ea4bf882e9740e75ceb3"></a><!-- doxytag: member="CEGUI::ItemListbox::selectRange" ref="ac799eff23e26ea4bf882e9740e75ceb3" args="(size_t a, size_t z)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ItemListbox::selectRange </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>z</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Select a range of items. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>Start item. (inclusive)</td></tr>
<tr><td class="paramname">z</td><td>End item. (inclusive) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a11c85f7abb6010a055e928ae2c5f9645"></a><!-- doxytag: member="CEGUI::ItemListbox::testClassName_impl" ref="a11c85f7abb6010a055e928ae2c5f9645" args="(const String &class_name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::ItemListbox::testClassName_impl </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>class_name</em></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">class_name</td><td>The class name that is to be checked.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this window was inherited from <em>class_name</em>. false if not. </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#abec44d48bbc7cf23c4e24314a4a91959">CEGUI::ScrolledItemListBase</a>.</p>
<p>References <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#abec44d48bbc7cf23c4e24314a4a91959">CEGUI::ScrolledItemListBase::testClassName_impl()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a21f6bf383af84a344571fd8a448ec64e"></a><!-- doxytag: member="CEGUI::ItemListbox::EventMultiSelectModeChanged" ref="a21f6bf383af84a344571fd8a448ec64e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1ItemListbox.html#a21f6bf383af84a344571fd8a448ec64e">CEGUI::ItemListbox::EventMultiSelectModeChanged</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> fired when the multiselect mode of the list box is changed. Handlers are passed a const <a class="el" href="classCEGUI_1_1WindowEventArgs.html" title="EventArgs based class that is used for objects passed to handlers triggered for events concerning som...">WindowEventArgs</a> reference with <a class="el" href="classCEGUI_1_1WindowEventArgs.html#a5817b522882b9648d445a20b8c354966" title="pointer to a Window object of relevance to the event.">WindowEventArgs::window</a> set to the <a class="el" href="classCEGUI_1_1ItemListbox.html" title="ItemListbox window class.">ItemListbox</a> whose multiselect mode has been changed. </p>
</div>
</div>
<a class="anchor" id="adc76148ff60cc5f6403777f90146a81c"></a><!-- doxytag: member="CEGUI::ItemListbox::EventSelectionChanged" ref="adc76148ff60cc5f6403777f90146a81c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1ItemListbox.html#adc76148ff60cc5f6403777f90146a81c">CEGUI::ItemListbox::EventSelectionChanged</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> fired when the list selection changes. Handlers are passed a const <a class="el" href="classCEGUI_1_1WindowEventArgs.html" title="EventArgs based class that is used for objects passed to handlers triggered for events concerning som...">WindowEventArgs</a> reference with <a class="el" href="classCEGUI_1_1WindowEventArgs.html#a5817b522882b9648d445a20b8c354966" title="pointer to a Window object of relevance to the event.">WindowEventArgs::window</a> set to the <a class="el" href="classCEGUI_1_1ItemListbox.html" title="ItemListbox window class.">ItemListbox</a> whose current selection has been changed. </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>
|
