1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
|
<!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::PopupMenu 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_1PopupMenu.html">PopupMenu</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::PopupMenu Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::PopupMenu" --><!-- doxytag: inherits="CEGUI::MenuBase" -->
<p>Base class for popup menus.
<a href="classCEGUI_1_1PopupMenu.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::PopupMenu:</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_1PopupMenu__inherit__graph.gif" border="0" usemap="#CEGUI_1_1PopupMenu_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1PopupMenu_inherit__map" id="CEGUI_1_1PopupMenu_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1MenuBase.html" title="Abstract base class for menus." alt="" coords="13,83,147,112"/><area shape="rect" id="node4" 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::PopupMenu:</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_1PopupMenu__coll__graph.gif" border="0" usemap="#CEGUI_1_1PopupMenu_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1PopupMenu_coll__map" id="CEGUI_1_1PopupMenu_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1MenuBase.html" title="Abstract base class for menus." alt="" coords="83,5,216,35"/><area shape="rect" id="node4" href="classCEGUI_1_1PopupMenuProperties_1_1FadeOutTime.html" title="Property to access the fade out time in seconds of the popup menu." alt="" coords="5,59,293,88"/><area shape="rect" id="node6" href="classCEGUI_1_1PopupMenuProperties_1_1FadeInTime.html" title="Property to access the fade in time in seconds of the popup menu." alt="" coords="11,112,288,141"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1PopupMenu-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_1PopupMenu.html#a8576d52a0428f5a0dcb7c6dfcbf4b636">getFadeInTime</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the fade in time for this popup menu. <a href="#a8576d52a0428f5a0dcb7c6dfcbf4b636"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a7a8f38968098ae405e7e8b241327e4de">getFadeOutTime</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the fade out time for this popup menu. <a href="#a7a8f38968098ae405e7e8b241327e4de"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a62e77e8b6ef9c73121b54d7d887d5780"></a><!-- doxytag: member="CEGUI::PopupMenu::isPopupMenuOpen" ref="a62e77e8b6ef9c73121b54d7d887d5780" args="(void) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a62e77e8b6ef9c73121b54d7d887d5780">isPopupMenuOpen</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find out if this popup menu is open or closed;. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#acb0f8f0b58971fa1643806b980ea3894">setFadeInTime</a> (float fadetime)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the fade in time for this popup menu. <a href="#acb0f8f0b58971fa1643806b980ea3894"></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_1PopupMenu.html#a3764970515789f7ab0daef43ca1b1d53">setFadeOutTime</a> (float fadetime)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the fade out time for this popup menu. <a href="#a3764970515789f7ab0daef43ca1b1d53"></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_1PopupMenu.html#afa868e767bd5616467763da15d48f145">openPopupMenu</a> (bool notify=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tells the popup menu to open. <a href="#afa868e767bd5616467763da15d48f145"></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_1PopupMenu.html#ae64f527a32e6330fda84379f4561ec3a">closePopupMenu</a> (bool notify=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tells the popup menu to close. <a href="#ae64f527a32e6330fda84379f4561ec3a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8dee343074e8d3005add8ee8a2d58252"></a><!-- doxytag: member="CEGUI::PopupMenu::PopupMenu" ref="a8dee343074e8d3005add8ee8a2d58252" args="(const String &type, const String &name)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a8dee343074e8d3005add8ee8a2d58252">PopupMenu</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_1PopupMenu.html" title="Base class for popup menus.">PopupMenu</a> objects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75722c54c391431c4fdb9ea0d1f5ea11"></a><!-- doxytag: member="CEGUI::PopupMenu::~PopupMenu" ref="a75722c54c391431c4fdb9ea0d1f5ea11" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a75722c54c391431c4fdb9ea0d1f5ea11">~PopupMenu</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1PopupMenu.html" title="Base class for popup menus.">PopupMenu</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="a44e0c3b6bb8c55775c662d63eb982fb6"></a><!-- doxytag: member="CEGUI::PopupMenu::EventNamespace" ref="a44e0c3b6bb8c55775c662d63eb982fb6" 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_1PopupMenu.html#a44e0c3b6bb8c55775c662d63eb982fb6">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="af46f6959d25108e2f7d5cb7efc413ed8"></a><!-- doxytag: member="CEGUI::PopupMenu::WidgetTypeName" ref="af46f6959d25108e2f7d5cb7efc413ed8" 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_1PopupMenu.html#af46f6959d25108e2f7d5cb7efc413ed8">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 colspan="2"><h2><a name="pro-methods"></a>
Protected 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_1PopupMenu.html#a9c68873c4b06781511e01d1a5aeac423">updateSelf</a> (float elapsed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform actual update processing for this <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>. <a href="#a9c68873c4b06781511e01d1a5aeac423"></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_1PopupMenu.html#af623844a7a70c77ce37c6c5143f22f2a">layoutItemWidgets</a> (void)</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_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a>. <a href="#af623844a7a70c77ce37c6c5143f22f2a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1Size.html">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a3d96ac686a00cbadf68d42d9ec4d68ff">getContentSize</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resizes the popup menu to exactly fit the content that is attached to it. <a href="#a3d96ac686a00cbadf68d42d9ec4d68ff"></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_1PopupMenu.html#ad0fbad7b1a623da5c809e5d15e0b58fd">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="#ad0fbad7b1a623da5c809e5d15e0b58fd"></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_1PopupMenu.html#a3605416ac82133202b5df828b319c11e">onAlphaChanged</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's alpha blend value is changed. <a href="#a3605416ac82133202b5df828b319c11e"></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_1PopupMenu.html#ada0998b9191a5d137563cb29ac530120">onDestructionStarted</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's destruction sequence has begun. <a href="#ada0998b9191a5d137563cb29ac530120"></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_1PopupMenu.html#a4eabeb742bad1ea0f74f7083f560a493">onShown</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 shown (made visible). <a href="#a4eabeb742bad1ea0f74f7083f560a493"></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_1PopupMenu.html#a6aaab487dbe0d2e6d90a37e82c5f6ffa">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="#a6aaab487dbe0d2e6d90a37e82c5f6ffa"></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_1PopupMenu.html#a6ec7315fc6286603e94fb2490cc5f4e4">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="#a6ec7315fc6286603e94fb2490cc5f4e4"></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_1PopupMenu.html#abd3ab033e849365e83078eb56158a2c0">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="#abd3ab033e849365e83078eb56158a2c0"></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="a27cd2bff52a8ac3ddd175730628114ff"></a><!-- doxytag: member="CEGUI::PopupMenu::d_origAlpha" ref="a27cd2bff52a8ac3ddd175730628114ff" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a27cd2bff52a8ac3ddd175730628114ff">d_origAlpha</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The original alpha of this window. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8249cce8f80a6a4ec82bfa734198f6ac"></a><!-- doxytag: member="CEGUI::PopupMenu::d_fadeElapsed" ref="a8249cce8f80a6a4ec82bfa734198f6ac" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a8249cce8f80a6a4ec82bfa734198f6ac">d_fadeElapsed</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The time in seconds this popup menu has been fading. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80e4d1f86f3cc065504b12aeae702981"></a><!-- doxytag: member="CEGUI::PopupMenu::d_fadeOutTime" ref="a80e4d1f86f3cc065504b12aeae702981" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a80e4d1f86f3cc065504b12aeae702981">d_fadeOutTime</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The time in seconds it takes for this popup menu to fade out. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6e491ca49836bb121d8bc605efdff2c"></a><!-- doxytag: member="CEGUI::PopupMenu::d_fadeInTime" ref="ad6e491ca49836bb121d8bc605efdff2c" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#ad6e491ca49836bb121d8bc605efdff2c">d_fadeInTime</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The time in seconds it takes for this popup menu to fade in. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17dcdad4bce5520406e93dca7bc0b42a"></a><!-- doxytag: member="CEGUI::PopupMenu::d_fading" ref="a17dcdad4bce5520406e93dca7bc0b42a" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a17dcdad4bce5520406e93dca7bc0b42a">d_fading</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if this popup menu is fading in/out. false if not <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a958d2ef49872a442ca35e858cc9d5dcc"></a><!-- doxytag: member="CEGUI::PopupMenu::d_fadingOut" ref="a958d2ef49872a442ca35e858cc9d5dcc" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a958d2ef49872a442ca35e858cc9d5dcc">d_fadingOut</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if this popup menu is fading out. false if fading in. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38785297f2f0532c6829fe61e69a6821"></a><!-- doxytag: member="CEGUI::PopupMenu::d_isOpen" ref="a38785297f2f0532c6829fe61e69a6821" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a38785297f2f0532c6829fe61e69a6821">d_isOpen</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if this popup menu is open. false if not. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class for popup menus. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae64f527a32e6330fda84379f4561ec3a"></a><!-- doxytag: member="CEGUI::PopupMenu::closePopupMenu" ref="ae64f527a32e6330fda84379f4561ec3a" args="(bool notify=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::PopupMenu::closePopupMenu </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>notify</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tells the popup menu to close. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">notify</td><td>true if the parent menu item (if any) is to handle the closing. false if not. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3d96ac686a00cbadf68d42d9ec4d68ff"></a><!-- doxytag: member="CEGUI::PopupMenu::getContentSize" ref="a3d96ac686a00cbadf68d42d9ec4d68ff" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCEGUI_1_1Size.html">Size</a> CEGUI::PopupMenu::getContentSize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resizes the popup menu to exactly fit the content that is attached to it. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1ItemListBase.html#a55be4e05c1e8fecb6af897329f460ed6">CEGUI::ItemListBase</a>.</p>
</div>
</div>
<a class="anchor" id="a8576d52a0428f5a0dcb7c6dfcbf4b636"></a><!-- doxytag: member="CEGUI::PopupMenu::getFadeInTime" ref="a8576d52a0428f5a0dcb7c6dfcbf4b636" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::PopupMenu::getFadeInTime </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 fade in time for this popup menu. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The time in seconds that it takes for the popup to fade in. 0 if fading is disabled. </dd></dl>
</div>
</div>
<a class="anchor" id="a7a8f38968098ae405e7e8b241327e4de"></a><!-- doxytag: member="CEGUI::PopupMenu::getFadeOutTime" ref="a7a8f38968098ae405e7e8b241327e4de" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::PopupMenu::getFadeOutTime </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 fade out time for this popup menu. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The time in seconds that it takes for the popup to fade out. 0 if fading is disabled. </dd></dl>
</div>
</div>
<a class="anchor" id="af623844a7a70c77ce37c6c5143f22f2a"></a><!-- doxytag: member="CEGUI::PopupMenu::layoutItemWidgets" ref="af623844a7a70c77ce37c6c5143f22f2a" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::PopupMenu::layoutItemWidgets </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Setup size and position for the item widgets attached to this <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1ItemListBase.html#a00677a8723e74b898ba03ee4265d9dcc">CEGUI::ItemListBase</a>.</p>
</div>
</div>
<a class="anchor" id="a3605416ac82133202b5df828b319c11e"></a><!-- doxytag: member="CEGUI::PopupMenu::onAlphaChanged" ref="a3605416ac82133202b5df828b319c11e" args="(WindowEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::PopupMenu::onAlphaChanged </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's alpha blend value is changed. </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#ad67da98096a6e29dd2a029a7d90a1a11">CEGUI::Window</a>.</p>
</div>
</div>
<a class="anchor" id="ada0998b9191a5d137563cb29ac530120"></a><!-- doxytag: member="CEGUI::PopupMenu::onDestructionStarted" ref="ada0998b9191a5d137563cb29ac530120" args="(WindowEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::PopupMenu::onDestructionStarted </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's destruction sequence has begun. </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#a7dfc74e1a9d535b01bee4bc2a4895271">CEGUI::Window</a>.</p>
</div>
</div>
<a class="anchor" id="a6aaab487dbe0d2e6d90a37e82c5f6ffa"></a><!-- doxytag: member="CEGUI::PopupMenu::onHidden" ref="a6aaab487dbe0d2e6d90a37e82c5f6ffa" args="(WindowEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::PopupMenu::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_1MenuBase.html#a675b4ffc352e1aa6c4b51cb2729bbbf4">CEGUI::MenuBase</a>.</p>
</div>
</div>
<a class="anchor" id="a6ec7315fc6286603e94fb2490cc5f4e4"></a><!-- doxytag: member="CEGUI::PopupMenu::onMouseButtonDown" ref="a6ec7315fc6286603e94fb2490cc5f4e4" args="(MouseEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::PopupMenu::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_1Window.html#abb30780cd259d8328df6ff0809f8ce4a">CEGUI::Window</a>.</p>
</div>
</div>
<a class="anchor" id="abd3ab033e849365e83078eb56158a2c0"></a><!-- doxytag: member="CEGUI::PopupMenu::onMouseButtonUp" ref="abd3ab033e849365e83078eb56158a2c0" args="(MouseEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::PopupMenu::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="a4eabeb742bad1ea0f74f7083f560a493"></a><!-- doxytag: member="CEGUI::PopupMenu::onShown" ref="a4eabeb742bad1ea0f74f7083f560a493" args="(WindowEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::PopupMenu::onShown </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 shown (made visible). </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#a953eeab59a0091bb2735a8a32decda98">CEGUI::Window</a>.</p>
</div>
</div>
<a class="anchor" id="afa868e767bd5616467763da15d48f145"></a><!-- doxytag: member="CEGUI::PopupMenu::openPopupMenu" ref="afa868e767bd5616467763da15d48f145" args="(bool notify=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::PopupMenu::openPopupMenu </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>notify</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tells the popup menu to open. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">notify</td><td>true if the parent menu item (if any) is to handle the opening. false if not. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acb0f8f0b58971fa1643806b980ea3894"></a><!-- doxytag: member="CEGUI::PopupMenu::setFadeInTime" ref="acb0f8f0b58971fa1643806b980ea3894" args="(float fadetime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::PopupMenu::setFadeInTime </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>fadetime</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the fade in time for this popup menu. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fadetime</td><td>The time in seconds that it takes for the popup to fade in. If this parameter is zero, fading is disabled. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3764970515789f7ab0daef43ca1b1d53"></a><!-- doxytag: member="CEGUI::PopupMenu::setFadeOutTime" ref="a3764970515789f7ab0daef43ca1b1d53" args="(float fadetime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::PopupMenu::setFadeOutTime </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>fadetime</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the fade out time for this popup menu. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fadetime</td><td>The time in seconds that it takes for the popup to fade out. If this parameter is zero, fading is disabled. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad0fbad7b1a623da5c809e5d15e0b58fd"></a><!-- doxytag: member="CEGUI::PopupMenu::testClassName_impl" ref="ad0fbad7b1a623da5c809e5d15e0b58fd" args="(const String &class_name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::PopupMenu::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_1MenuBase.html#a305654b984ca2f384d70f86b07adc6d9">CEGUI::MenuBase</a>.</p>
<p>References <a class="el" href="classCEGUI_1_1MenuBase.html#a305654b984ca2f384d70f86b07adc6d9">CEGUI::MenuBase::testClassName_impl()</a>.</p>
</div>
</div>
<a class="anchor" id="a9c68873c4b06781511e01d1a5aeac423"></a><!-- doxytag: member="CEGUI::PopupMenu::updateSelf" ref="a9c68873c4b06781511e01d1a5aeac423" args="(float elapsed)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::PopupMenu::updateSelf </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>elapsed</em></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Perform actual update processing for this <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>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">elapsed</td><td>float value indicating the number of seconds elapsed since the last update call.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#af88acbf0fef0d60267500bd3685c5de5">CEGUI::Window</a>.</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>
|