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
|
<!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::ComboDropList 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_1ComboDropList.html">ComboDropList</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::ComboDropList Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::ComboDropList" --><!-- doxytag: inherits="CEGUI::Listbox" -->
<p>Base class for the combo box drop down list. This is a specialisation of the <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> class.
<a href="classCEGUI_1_1ComboDropList.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::ComboDropList:</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_1ComboDropList__inherit__graph.gif" border="0" usemap="#CEGUI_1_1ComboDropList_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1ComboDropList_inherit__map" id="CEGUI_1_1ComboDropList_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget." alt="" coords="29,83,144,112"/><area shape="rect" id="node4" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv..." alt="" coords="27,5,147,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::ComboDropList:</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_1ComboDropList__coll__graph.gif" border="0" usemap="#CEGUI_1_1ComboDropList_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1ComboDropList_coll__map" id="CEGUI_1_1ComboDropList_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget." alt="" coords="145,411,260,440"/><area shape="rect" id="node4" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items." alt="" coords="402,199,544,228"/><area shape="rect" id="node6" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="128,5,234,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1ComboDropList-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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComboDropList.html#aeb064f89fda76d6178a22135f20d6b68">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="#aeb064f89fda76d6178a22135f20d6b68"></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_1ComboDropList.html#a46ac45ec0a00ac34b8e41c0d28fbd5ce">setArmed</a> (bool setting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set whether the drop-list is 'armed' for selection. <a href="#a46ac45ec0a00ac34b8e41c0d28fbd5ce"></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_1ComboDropList.html#a4ecdc09f8cc5192419a8112b98c2c283">isArmed</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the 'armed' state of the <a class="el" href="classCEGUI_1_1ComboDropList.html" title="Base class for the combo box drop down list. This is a specialisation of the Listbox class...">ComboDropList</a>. <a href="#a4ecdc09f8cc5192419a8112b98c2c283"></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_1ComboDropList.html#aaa8c458c34514153c97304bcf47c53ac">setAutoArmEnabled</a> (bool setting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the mode of operation for the <a class="el" href="classCEGUI_1_1ComboDropList.html" title="Base class for the combo box drop down list. This is a specialisation of the Listbox class...">ComboDropList</a>. <a href="#aaa8c458c34514153c97304bcf47c53ac"></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_1ComboDropList.html#ae60d98a23587ec6aeb9a8dac6d7dcab8">isAutoArmEnabled</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the mode of operation for the drop-list <a href="#ae60d98a23587ec6aeb9a8dac6d7dcab8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8857a12cddb0de4f8a5469cad8312355"></a><!-- doxytag: member="CEGUI::ComboDropList::ComboDropList" ref="a8857a12cddb0de4f8a5469cad8312355" args="(const String &type, const String &name)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComboDropList.html#a8857a12cddb0de4f8a5469cad8312355">ComboDropList</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 <a class="el" href="classCEGUI_1_1ComboDropList.html" title="Base class for the combo box drop down list. This is a specialisation of the Listbox class...">ComboDropList</a> base class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a209f00edefe2b41a6a6eb0154edb0844"></a><!-- doxytag: member="CEGUI::ComboDropList::~ComboDropList" ref="a209f00edefe2b41a6a6eb0154edb0844" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComboDropList.html#a209f00edefe2b41a6a6eb0154edb0844">~ComboDropList</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1ComboDropList.html" title="Base class for the combo box drop down list. This is a specialisation of the Listbox class...">ComboDropList</a> base class. <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="abaf1118717392f2bc8952caab91aa922"></a><!-- doxytag: member="CEGUI::ComboDropList::EventNamespace" ref="abaf1118717392f2bc8952caab91aa922" 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_1ComboDropList.html#abaf1118717392f2bc8952caab91aa922">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="a723323c5c6dcaa672a576763e64aaea8"></a><!-- doxytag: member="CEGUI::ComboDropList::WidgetTypeName" ref="a723323c5c6dcaa672a576763e64aaea8" 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_1ComboDropList.html#a723323c5c6dcaa672a576763e64aaea8">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_1ComboDropList.html#ac19da6f6bee8c3f43b5b620c9b7f333a">EventListSelectionAccepted</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">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComboDropList.html#a8d4176e66c3a1f87cf95c85c4d162b7d">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="#a8d4176e66c3a1f87cf95c85c4d162b7d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0986a0d4b063f6ece76309e1e92a0f87"></a><!-- doxytag: member="CEGUI::ComboDropList::onListSelectionAccepted" ref="a0986a0d4b063f6ece76309e1e92a0f87" args="(WindowEventArgs &e)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComboDropList.html#a0986a0d4b063f6ece76309e1e92a0f87">onListSelectionAccepted</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler for when list selection is confirmed. <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_1ComboDropList.html#a2748e7191189ad868d12f34ff517fbdb">onMouseMove</a> (<a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called when the mouse cursor has been moved within this window's area. <a href="#a2748e7191189ad868d12f34ff517fbdb"></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_1ComboDropList.html#aaee9645fb1c2dae229a472ea49520f05">onMouseButtonDown</a> (<a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called when a mouse button has been depressed within this window's area. <a href="#aaee9645fb1c2dae229a472ea49520f05"></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_1ComboDropList.html#ab40d2d0c4f7d70e39a9e333ec0af9846">onMouseButtonUp</a> (<a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called when a mouse button has been released within this window's area. <a href="#ab40d2d0c4f7d70e39a9e333ec0af9846"></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_1ComboDropList.html#a25d76e9f05551e82e1ebabaac6580d06">onCaptureLost</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called when this window loses capture of mouse inputs. <a href="#a25d76e9f05551e82e1ebabaac6580d06"></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_1ComboDropList.html#a446266e330b63dcbabc90668b58f6279">onActivated</a> (<a class="el" href="classCEGUI_1_1ActivationEventArgs.html">ActivationEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called when this window has become the active window. <a href="#a446266e330b63dcbabc90668b58f6279"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeff040567186c045fc16f2cbdf3470fc"></a><!-- doxytag: member="CEGUI::ComboDropList::onListContentsChanged" ref="aeff040567186c045fc16f2cbdf3470fc" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComboDropList.html#aeff040567186c045fc16f2cbdf3470fc">onListContentsChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called internally when the list contents are changed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7bd9697f1491130ad351ef5ea30b9361"></a><!-- doxytag: member="CEGUI::ComboDropList::onSelectionChanged" ref="a7bd9697f1491130ad351ef5ea30b9361" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComboDropList.html#a7bd9697f1491130ad351ef5ea30b9361">onSelectionChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called internally when the currently selected item or items changes. <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="a8c3358af84d92373277ef4b2855327fa"></a><!-- doxytag: member="CEGUI::ComboDropList::d_autoArm" ref="a8c3358af84d92373277ef4b2855327fa" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComboDropList.html#a8c3358af84d92373277ef4b2855327fa">d_autoArm</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if the box auto-arms when the mouse enters it. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8abe63f3c3f7e3a1fcd9a848f545dc3e"></a><!-- doxytag: member="CEGUI::ComboDropList::d_armed" ref="a8abe63f3c3f7e3a1fcd9a848f545dc3e" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComboDropList.html#a8abe63f3c3f7e3a1fcd9a848f545dc3e">d_armed</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true when item selection has been armed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14fc01d64676d37eccd6030b8d3c9a00"></a><!-- doxytag: member="CEGUI::ComboDropList::d_lastClickSelected" ref="a14fc01d64676d37eccd6030b8d3c9a00" args="" -->
<a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComboDropList.html#a14fc01d64676d37eccd6030b8d3c9a00">d_lastClickSelected</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Item last accepted by user. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class for the combo box drop down list. This is a specialisation of the <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> class. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aeb064f89fda76d6178a22135f20d6b68"></a><!-- doxytag: member="CEGUI::ComboDropList::initialiseComponents" ref="aeb064f89fda76d6178a22135f20d6b68" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ComboDropList::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_1Listbox.html#a31a4dc42adca5d28af5f463c3a6efdda">CEGUI::Listbox</a>.</p>
</div>
</div>
<a class="anchor" id="a4ecdc09f8cc5192419a8112b98c2c283"></a><!-- doxytag: member="CEGUI::ComboDropList::isArmed" ref="a4ecdc09f8cc5192419a8112b98c2c283" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::ComboDropList::isArmed </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 'armed' state of the <a class="el" href="classCEGUI_1_1ComboDropList.html" title="Base class for the combo box drop down list. This is a specialisation of the Listbox class...">ComboDropList</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the box is armed; items will be highlighted and the next left button up event will cause dismissal and possible item selection.</li>
</ul>
</dd></dl>
<ul>
<li>false if the box is not armed; items will not be highlighted or selected until the box is armed. </li>
</ul>
</div>
</div>
<a class="anchor" id="ae60d98a23587ec6aeb9a8dac6d7dcab8"></a><!-- doxytag: member="CEGUI::ComboDropList::isAutoArmEnabled" ref="ae60d98a23587ec6aeb9a8dac6d7dcab8" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::ComboDropList::isAutoArmEnabled </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 the mode of operation for the drop-list </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the <a class="el" href="classCEGUI_1_1ComboDropList.html" title="Base class for the combo box drop down list. This is a specialisation of the Listbox class...">ComboDropList</a> auto-arms when the mouse enters the box.</li>
<li>false if the user must click to arm the box. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a446266e330b63dcbabc90668b58f6279"></a><!-- doxytag: member="CEGUI::ComboDropList::onActivated" ref="a446266e330b63dcbabc90668b58f6279" args="(ActivationEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ComboDropList::onActivated </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1ActivationEventArgs.html">ActivationEventArgs</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 this window has become the active window. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1ActivationEventArgs.html" title="EventArgs based class that is used for Activated and Deactivated window events.">ActivationEventArgs</a> class whose 'otherWindow' field is set to the window that previously was active, or NULL for none. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a26b98b08ce24fc7eea106d87d32c608e">CEGUI::Window</a>.</p>
</div>
</div>
<a class="anchor" id="a25d76e9f05551e82e1ebabaac6580d06"></a><!-- doxytag: member="CEGUI::ComboDropList::onCaptureLost" ref="a25d76e9f05551e82e1ebabaac6580d06" args="(WindowEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ComboDropList::onCaptureLost </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</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 this window loses capture of mouse inputs. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td><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> object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a14d613fe66ba50dacb9ee9490b64d26e">CEGUI::Window</a>.</p>
</div>
</div>
<a class="anchor" id="aaee9645fb1c2dae229a472ea49520f05"></a><!-- doxytag: member="CEGUI::ComboDropList::onMouseButtonDown" ref="aaee9645fb1c2dae229a472ea49520f05" args="(MouseEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ComboDropList::onMouseButtonDown </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</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 mouse button has been depressed within this window's area. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1MouseEventArgs.html" title="EventArgs based class that is used for objects passed to input event handlers concerning mouse input...">MouseEventArgs</a> object. All fields are valid. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Listbox.html#a28a206ab1bd912843155dfedc8af6f8f">CEGUI::Listbox</a>.</p>
</div>
</div>
<a class="anchor" id="ab40d2d0c4f7d70e39a9e333ec0af9846"></a><!-- doxytag: member="CEGUI::ComboDropList::onMouseButtonUp" ref="ab40d2d0c4f7d70e39a9e333ec0af9846" args="(MouseEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ComboDropList::onMouseButtonUp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</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 mouse button has been released within this window's area. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1MouseEventArgs.html" title="EventArgs based class that is used for objects passed to input event handlers concerning mouse input...">MouseEventArgs</a> object. All fields are valid. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#ac03b4971d121ff91d6fc771386029792">CEGUI::Window</a>.</p>
</div>
</div>
<a class="anchor" id="a2748e7191189ad868d12f34ff517fbdb"></a><!-- doxytag: member="CEGUI::ComboDropList::onMouseMove" ref="a2748e7191189ad868d12f34ff517fbdb" args="(MouseEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ComboDropList::onMouseMove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</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 the mouse cursor has been moved within this window's area. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1MouseEventArgs.html" title="EventArgs based class that is used for objects passed to input event handlers concerning mouse input...">MouseEventArgs</a> object. All fields are valid. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Listbox.html#af00477dcc392f47d45ec8559f5911e51">CEGUI::Listbox</a>.</p>
</div>
</div>
<a class="anchor" id="a46ac45ec0a00ac34b8e41c0d28fbd5ce"></a><!-- doxytag: member="CEGUI::ComboDropList::setArmed" ref="a46ac45ec0a00ac34b8e41c0d28fbd5ce" args="(bool setting)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ComboDropList::setArmed </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 the drop-list is 'armed' for selection. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This setting is not exclusively under client control; the <a class="el" href="classCEGUI_1_1ComboDropList.html" title="Base class for the combo box drop down list. This is a specialisation of the Listbox class...">ComboDropList</a> will auto-arm in response to certain left mouse button events. This is also dependant upon the autoArm setting of the <a class="el" href="classCEGUI_1_1ComboDropList.html" title="Base class for the combo box drop down list. This is a specialisation of the Listbox class...">ComboDropList</a>.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">setting</td><td><ul>
<li>true to arm the box; items will be highlighted and the next left button up event will cause dismissal and possible item selection.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<ul>
<li>false to disarm the box; items will not be highlighted or selected until the box is armed.</li>
</ul>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="aaa8c458c34514153c97304bcf47c53ac"></a><!-- doxytag: member="CEGUI::ComboDropList::setAutoArmEnabled" ref="aaa8c458c34514153c97304bcf47c53ac" args="(bool setting)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ComboDropList::setAutoArmEnabled </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 the mode of operation for the <a class="el" href="classCEGUI_1_1ComboDropList.html" title="Base class for the combo box drop down list. This is a specialisation of the Listbox class...">ComboDropList</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">setting</td><td><ul>
<li>true if the <a class="el" href="classCEGUI_1_1ComboDropList.html" title="Base class for the combo box drop down list. This is a specialisation of the Listbox class...">ComboDropList</a> auto-arms when the mouse enters the box.</li>
<li>false if the user must click to arm the box.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a8d4176e66c3a1f87cf95c85c4d162b7d"></a><!-- doxytag: member="CEGUI::ComboDropList::testClassName_impl" ref="a8d4176e66c3a1f87cf95c85c4d162b7d" args="(const String &class_name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::ComboDropList::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, protected, 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_1Listbox.html#a0038b304b9174e6f39aae7189707d40d">CEGUI::Listbox</a>.</p>
<p>References <a class="el" href="classCEGUI_1_1Listbox.html#a0038b304b9174e6f39aae7189707d40d">CEGUI::Listbox::testClassName_impl()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ac19da6f6bee8c3f43b5b620c9b7f333a"></a><!-- doxytag: member="CEGUI::ComboDropList::EventListSelectionAccepted" ref="ac19da6f6bee8c3f43b5b620c9b7f333a" 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_1ComboDropList.html#ac19da6f6bee8c3f43b5b620c9b7f333a">CEGUI::ComboDropList::EventListSelectionAccepted</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 user confirms the selection by clicking the mouse. 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_1ComboDropList.html" title="Base class for the combo box drop down list. This is a specialisation of the Listbox class...">ComboDropList</a> whose selection has been confirmed by the user. </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>
|
