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
|
<!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::MenuBase 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_1MenuBase.html">MenuBase</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::MenuBase Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::MenuBase" --><!-- doxytag: inherits="CEGUI::ItemListBase" -->
<p>Abstract base class for menus.
<a href="classCEGUI_1_1MenuBase.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::MenuBase:</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_1MenuBase__inherit__graph.gif" border="0" usemap="#CEGUI_1_1MenuBase_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1MenuBase_inherit__map" id="CEGUI_1_1MenuBase_inherit__map">
<area shape="rect" id="node5" href="classCEGUI_1_1Menubar.html" title="Base class for menu bars." alt="" coords="19,160,141,189"/><area shape="rect" id="node2" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets." alt="" coords="5,5,155,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::MenuBase:</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_1MenuBase__coll__graph.gif" border="0" usemap="#CEGUI_1_1MenuBase_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1MenuBase_coll__map" id="CEGUI_1_1MenuBase_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets." alt="" coords="105,5,255,35"/><area shape="rect" id="node4" href="classCEGUI_1_1MenuItem.html" title="Base class for menu items." alt="" coords="115,59,245,88"/><area shape="rect" id="node6" href="classCEGUI_1_1MenuBaseProperties_1_1AutoCloseNestedPopups.html" title="Property to set if the menu should close all its open child popups, when it gets hidden." alt="" coords="5,112,355,141"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1MenuBase-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">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#a368d980a69837e104eb34638d206eb5c">getItemSpacing</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the item spacing for this menu. <a href="#a368d980a69837e104eb34638d206eb5c"></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_1MenuBase.html#af8ba92fe83b527ac05930839e286037a">isMultiplePopupsAllowed</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether this menu allows multiple popup menus to open at the same time. <a href="#af8ba92fe83b527ac05930839e286037a"></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_1MenuBase.html#a95fffa724c12db58cdf0fb54bad65d5a">getAutoCloseNestedPopups</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether this menu should close all its open child popups, when it gets hidden. <a href="#a95fffa724c12db58cdf0fb54bad65d5a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1MenuItem.html">MenuItem</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#a9bd3bd9c63921ed5247ec2802453302d">getPopupMenuItem</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get currently opened <a class="el" href="classCEGUI_1_1MenuItem.html" title="Base class for menu items.">MenuItem</a> in this menu. Returns NULL if no menu item is open. <a href="#a9bd3bd9c63921ed5247ec2802453302d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1fdc6c12ed096081496287f71c816787"></a><!-- doxytag: member="CEGUI::MenuBase::setItemSpacing" ref="a1fdc6c12ed096081496287f71c816787" args="(float spacing)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#a1fdc6c12ed096081496287f71c816787">setItemSpacing</a> (float spacing)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the item spacing for this menu. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#a3a9a755d9383ce11b1cfb1e9b59cfb9d">changePopupMenuItem</a> (<a class="el" href="classCEGUI_1_1MenuItem.html">MenuItem</a> *item)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the currently open <a class="el" href="classCEGUI_1_1MenuItem.html" title="Base class for menu items.">MenuItem</a> in this menu. <a href="#a3a9a755d9383ce11b1cfb1e9b59cfb9d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac376faf2f3439ab46f7eace6849e240"></a><!-- doxytag: member="CEGUI::MenuBase::setAllowMultiplePopups" ref="aac376faf2f3439ab46f7eace6849e240" args="(bool setting)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#aac376faf2f3439ab46f7eace6849e240">setAllowMultiplePopups</a> (bool setting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set whether this menu allows multiple popup menus to be opened simultaneously. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c12ed6f499eb10bd0dec5c12f40d59e"></a><!-- doxytag: member="CEGUI::MenuBase::setAutoCloseNestedPopups" ref="a7c12ed6f499eb10bd0dec5c12f40d59e" args="(bool setting)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#a7c12ed6f499eb10bd0dec5c12f40d59e">setAutoCloseNestedPopups</a> (bool setting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set whether the menu should close all its open child popups, when it gets hidden. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee23e933da0ea0a362dd6f63e5244b0d"></a><!-- doxytag: member="CEGUI::MenuBase::setPopupMenuItemClosing" ref="aee23e933da0ea0a362dd6f63e5244b0d" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#aee23e933da0ea0a362dd6f63e5244b0d">setPopupMenuItemClosing</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">tells the current popup that it should start its closing timer. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff4b55bc981fbc0f05a002f36d5b58b5"></a><!-- doxytag: member="CEGUI::MenuBase::MenuBase" ref="aff4b55bc981fbc0f05a002f36d5b58b5" args="(const String &type, const String &name)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#aff4b55bc981fbc0f05a002f36d5b58b5">MenuBase</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_1MenuBase.html" title="Abstract base class for menus.">MenuBase</a> objects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d117a954cf7c4f2c0ea9258dec91205"></a><!-- doxytag: member="CEGUI::MenuBase::~MenuBase" ref="a5d117a954cf7c4f2c0ea9258dec91205" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#a5d117a954cf7c4f2c0ea9258dec91205">~MenuBase</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1MenuBase.html" title="Abstract base class for menus.">MenuBase</a> objects. <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="aac9f55e907c43c3a25c23ec899df5660"></a><!-- doxytag: member="CEGUI::MenuBase::EventNamespace" ref="aac9f55e907c43c3a25c23ec899df5660" 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_1MenuBase.html#aac9f55e907c43c3a25c23ec899df5660">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">static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#a19f1ffa6c23528c694772ab87ba54d8c">EventPopupOpened</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_1MenuBase.html#a4d9e3446bae22d4fa2b9f558deaf4b68">EventPopupClosed</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="anchor" id="a4547fc7b1ef6eed810bf8ddae2400858"></a><!-- doxytag: member="CEGUI::MenuBase::onPopupOpened" ref="a4547fc7b1ef6eed810bf8ddae2400858" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#a4547fc7b1ef6eed810bf8ddae2400858">onPopupOpened</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">handler invoked internally when the a <a class="el" href="classCEGUI_1_1MenuItem.html" title="Base class for menu items.">MenuItem</a> attached to this menu opens its popup. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11733a6c16cfda98fb6f6e0dc4834372"></a><!-- doxytag: member="CEGUI::MenuBase::onPopupClosed" ref="a11733a6c16cfda98fb6f6e0dc4834372" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#a11733a6c16cfda98fb6f6e0dc4834372">onPopupClosed</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">handler invoked internally when the a <a class="el" href="classCEGUI_1_1MenuItem.html" title="Base class for menu items.">MenuItem</a> attached to this menu closes its popup. <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_1MenuBase.html#aa40ce63ac60bc2e3dc8aea2439ebfa57">onChildRemoved</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 a child window is removed from this window. <a href="#aa40ce63ac60bc2e3dc8aea2439ebfa57"></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_1MenuBase.html#a675b4ffc352e1aa6c4b51cb2729bbbf4">onHidden</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 the window is hidden. <a href="#a675b4ffc352e1aa6c4b51cb2729bbbf4"></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_1MenuBase.html#a305654b984ca2f384d70f86b07adc6d9">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="#a305654b984ca2f384d70f86b07adc6d9"></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="a101c9f836bb21a774c6b2c5381fb7671"></a><!-- doxytag: member="CEGUI::MenuBase::d_itemSpacing" ref="a101c9f836bb21a774c6b2c5381fb7671" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#a101c9f836bb21a774c6b2c5381fb7671">d_itemSpacing</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The spacing in pixels between items. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7fbd48481d662f89f36e3d9db0d3f29"></a><!-- doxytag: member="CEGUI::MenuBase::d_popupItem" ref="ad7fbd48481d662f89f36e3d9db0d3f29" args="" -->
<a class="el" href="classCEGUI_1_1MenuItem.html">MenuItem</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#ad7fbd48481d662f89f36e3d9db0d3f29">d_popupItem</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The currently open <a class="el" href="classCEGUI_1_1MenuItem.html" title="Base class for menu items.">MenuItem</a>. NULL if no item is open. If multiple popups are allowed, this means nothing. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5058b11ad35f3d06676d9b7dda8192c4"></a><!-- doxytag: member="CEGUI::MenuBase::d_allowMultiplePopups" ref="a5058b11ad35f3d06676d9b7dda8192c4" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#a5058b11ad35f3d06676d9b7dda8192c4">d_allowMultiplePopups</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if multiple popup menus are allowed simultaneously. false if not. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7117f43cf1d9d4bac183afaa06495d2"></a><!-- doxytag: member="CEGUI::MenuBase::d_autoCloseNestedPopups" ref="af7117f43cf1d9d4bac183afaa06495d2" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MenuBase.html#af7117f43cf1d9d4bac183afaa06495d2">d_autoCloseNestedPopups</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if the menu should close all its open child popups, when it gets hidden <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract base class for menus. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3a9a755d9383ce11b1cfb1e9b59cfb9d"></a><!-- doxytag: member="CEGUI::MenuBase::changePopupMenuItem" ref="a3a9a755d9383ce11b1cfb1e9b59cfb9d" args="(MenuItem *item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::MenuBase::changePopupMenuItem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1MenuItem.html">MenuItem</a> * </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Change the currently open <a class="el" href="classCEGUI_1_1MenuItem.html" title="Base class for menu items.">MenuItem</a> in this menu. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">item</td><td>Pointer to a <a class="el" href="classCEGUI_1_1MenuItem.html" title="Base class for menu items.">MenuItem</a> to open or NULL to close any opened. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a95fffa724c12db58cdf0fb54bad65d5a"></a><!-- doxytag: member="CEGUI::MenuBase::getAutoCloseNestedPopups" ref="a95fffa724c12db58cdf0fb54bad65d5a" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::MenuBase::getAutoCloseNestedPopups </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 menu should close all its open child popups, when it gets hidden. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the menu should close all its open child popups, when it gets hidden </dd></dl>
</div>
</div>
<a class="anchor" id="a368d980a69837e104eb34638d206eb5c"></a><!-- doxytag: member="CEGUI::MenuBase::getItemSpacing" ref="a368d980a69837e104eb34638d206eb5c" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::MenuBase::getItemSpacing </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>Get the item spacing for this menu. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A float value with the current item spacing for this menu </dd></dl>
</div>
</div>
<a class="anchor" id="a9bd3bd9c63921ed5247ec2802453302d"></a><!-- doxytag: member="CEGUI::MenuBase::getPopupMenuItem" ref="a9bd3bd9c63921ed5247ec2802453302d" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1MenuItem.html">MenuItem</a>* CEGUI::MenuBase::getPopupMenuItem </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>Get currently opened <a class="el" href="classCEGUI_1_1MenuItem.html" title="Base class for menu items.">MenuItem</a> in this menu. Returns NULL if no menu item is open. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the <a class="el" href="classCEGUI_1_1MenuItem.html" title="Base class for menu items.">MenuItem</a> currently open. </dd></dl>
</div>
</div>
<a class="anchor" id="af8ba92fe83b527ac05930839e286037a"></a><!-- doxytag: member="CEGUI::MenuBase::isMultiplePopupsAllowed" ref="af8ba92fe83b527ac05930839e286037a" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::MenuBase::isMultiplePopupsAllowed </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 menu allows multiple popup menus to open at the same time. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this menu allows multiple popup menus to be opened simultaneously. false if not </dd></dl>
</div>
</div>
<a class="anchor" id="aa40ce63ac60bc2e3dc8aea2439ebfa57"></a><!-- doxytag: member="CEGUI::MenuBase::onChildRemoved" ref="aa40ce63ac60bc2e3dc8aea2439ebfa57" args="(WindowEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::MenuBase::onChildRemoved </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 a child window is removed from this 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_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 the window that has been removed. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#aec8b76723433b87ae5b8cef0be76ae1f">CEGUI::Window</a>.</p>
</div>
</div>
<a class="anchor" id="a675b4ffc352e1aa6c4b51cb2729bbbf4"></a><!-- doxytag: member="CEGUI::MenuBase::onHidden" ref="a675b4ffc352e1aa6c4b51cb2729bbbf4" args="(WindowEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::MenuBase::onHidden </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 the window is hidden. </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#abca3d6561baa9f6bc41fa7ec112bc499">CEGUI::Window</a>.</p>
<p>Reimplemented in <a class="el" href="classCEGUI_1_1PopupMenu.html#a6aaab487dbe0d2e6d90a37e82c5f6ffa">CEGUI::PopupMenu</a>.</p>
</div>
</div>
<a class="anchor" id="a305654b984ca2f384d70f86b07adc6d9"></a><!-- doxytag: member="CEGUI::MenuBase::testClassName_impl" ref="a305654b984ca2f384d70f86b07adc6d9" args="(const String &class_name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::MenuBase::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_1ItemListBase.html#a9c26c62516fd505f667c8a7c19338691">CEGUI::ItemListBase</a>.</p>
<p>Reimplemented in <a class="el" href="classCEGUI_1_1Menubar.html#a72ba244d28b1d1663ac7f48852d6f9a1">CEGUI::Menubar</a>, and <a class="el" href="classCEGUI_1_1PopupMenu.html#ad0fbad7b1a623da5c809e5d15e0b58fd">CEGUI::PopupMenu</a>.</p>
<p>References <a class="el" href="classCEGUI_1_1ItemListBase.html#a9c26c62516fd505f667c8a7c19338691">CEGUI::ItemListBase::testClassName_impl()</a>.</p>
<p>Referenced by <a class="el" href="classCEGUI_1_1PopupMenu.html#ad0fbad7b1a623da5c809e5d15e0b58fd">CEGUI::PopupMenu::testClassName_impl()</a>, and <a class="el" href="classCEGUI_1_1Menubar.html#a72ba244d28b1d1663ac7f48852d6f9a1">CEGUI::Menubar::testClassName_impl()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a4d9e3446bae22d4fa2b9f558deaf4b68"></a><!-- doxytag: member="CEGUI::MenuBase::EventPopupClosed" ref="a4d9e3446bae22d4fa2b9f558deaf4b68" 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_1MenuBase.html#a4d9e3446bae22d4fa2b9f558deaf4b68">CEGUI::MenuBase::EventPopupClosed</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 a <a class="el" href="classCEGUI_1_1MenuItem.html" title="Base class for menu items.">MenuItem</a> attached to this menu closed a <a class="el" href="classCEGUI_1_1PopupMenu.html" title="Base class for popup menus.">PopupMenu</a>. 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_1PopupMenu.html" title="Base class for popup menus.">PopupMenu</a> that was closed. </p>
</div>
</div>
<a class="anchor" id="a19f1ffa6c23528c694772ab87ba54d8c"></a><!-- doxytag: member="CEGUI::MenuBase::EventPopupOpened" ref="a19f1ffa6c23528c694772ab87ba54d8c" 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_1MenuBase.html#a19f1ffa6c23528c694772ab87ba54d8c">CEGUI::MenuBase::EventPopupOpened</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 a <a class="el" href="classCEGUI_1_1MenuItem.html" title="Base class for menu items.">MenuItem</a> attached to this menu opened a <a class="el" href="classCEGUI_1_1PopupMenu.html" title="Base class for popup menus.">PopupMenu</a>. 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_1PopupMenu.html" title="Base class for popup menus.">PopupMenu</a> that was opened. </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>
|
