1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>Crazy Eddies GUI System: CEGUI::PopupMenu Class Reference</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.4 -->
11
<script type="text/javascript">
12
function hasClass(ele,cls) {
13
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
16
function addClass(ele,cls) {
17
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
20
function removeClass(ele,cls) {
21
if (hasClass(ele,cls)) {
22
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
23
ele.className=ele.className.replace(reg,' ');
27
function toggleVisibility(linkObj) {
28
var base = linkObj.getAttribute('id');
29
var summary = document.getElementById(base + '-summary');
30
var content = document.getElementById(base + '-content');
31
var trigger = document.getElementById(base + '-trigger');
32
if ( hasClass(linkObj,'closed') ) {
33
summary.style.display = 'none';
34
content.style.display = 'block';
35
trigger.src = 'open.png';
36
removeClass(linkObj,'closed');
37
addClass(linkObj,'opened');
38
} else if ( hasClass(linkObj,'opened') ) {
39
summary.style.display = 'block';
40
content.style.display = 'none';
41
trigger.src = 'closed.png';
42
removeClass(linkObj,'opened');
43
addClass(linkObj,'closed');
50
<table cellspacing="0" cellpadding="0">
52
<tr style="height: 56px;">
53
<td style="padding-left: 0.5em;">
54
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
60
<div id="navrow1" class="tabs">
62
<li><a href="index.html"><span>Main Page</span></a></li>
63
<li><a href="pages.html"><span>Related Pages</span></a></li>
64
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
65
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
66
<li><a href="files.html"><span>Files</span></a></li>
69
<div id="navrow2" class="tabs2">
71
<li><a href="annotated.html"><span>Class List</span></a></li>
72
<li><a href="classes.html"><span>Class Index</span></a></li>
73
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
74
<li><a href="functions.html"><span>Class Members</span></a></li>
77
<div id="nav-path" class="navpath">
79
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
80
<li class="navelem"><a class="el" href="classCEGUI_1_1PopupMenu.html">PopupMenu</a> </li>
86
<a href="#pub-methods">Public Member Functions</a> |
87
<a href="#pub-static-attribs">Static Public Attributes</a> |
88
<a href="#pro-methods">Protected Member Functions</a> |
89
<a href="#pro-attribs">Protected Attributes</a> </div>
90
<div class="headertitle">
91
<div class="title">CEGUI::PopupMenu Class Reference</div> </div>
93
<div class="contents">
94
<!-- doxytag: class="CEGUI::PopupMenu" --><!-- doxytag: inherits="CEGUI::MenuBase" -->
95
<p>Base class for popup menus.
96
<a href="classCEGUI_1_1PopupMenu.html#details">More...</a></p>
97
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
98
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::PopupMenu:</div>
99
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
101
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
102
<div class="center"><img src="classCEGUI_1_1PopupMenu__inherit__graph.gif" border="0" usemap="#CEGUI_1_1PopupMenu_inherit__map" alt="Inheritance graph"/></div>
103
<map name="CEGUI_1_1PopupMenu_inherit__map" id="CEGUI_1_1PopupMenu_inherit__map">
104
<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>
105
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
106
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
107
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::PopupMenu:</div>
108
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
110
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
111
<div class="center"><img src="classCEGUI_1_1PopupMenu__coll__graph.gif" border="0" usemap="#CEGUI_1_1PopupMenu_coll__map" alt="Collaboration graph"/></div>
112
<map name="CEGUI_1_1PopupMenu_coll__map" id="CEGUI_1_1PopupMenu_coll__map">
113
<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>
114
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
116
<p><a href="classCEGUI_1_1PopupMenu-members.html">List of all members.</a></p>
117
<table class="memberdecls">
118
<tr><td colspan="2"><h2><a name="pub-methods"></a>
119
Public Member Functions</h2></td></tr>
120
<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>
121
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the fade in time for this popup menu. <a href="#a8576d52a0428f5a0dcb7c6dfcbf4b636"></a><br/></td></tr>
122
<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>
123
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the fade out time for this popup menu. <a href="#a7a8f38968098ae405e7e8b241327e4de"></a><br/></td></tr>
124
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a62e77e8b6ef9c73121b54d7d887d5780"></a><!-- doxytag: member="CEGUI::PopupMenu::isPopupMenuOpen" ref="a62e77e8b6ef9c73121b54d7d887d5780" args="(void) const " -->
125
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a62e77e8b6ef9c73121b54d7d887d5780">isPopupMenuOpen</a> (void) const </td></tr>
126
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find out if this popup menu is open or closed;. <br/></td></tr>
127
<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>
128
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the fade in time for this popup menu. <a href="#acb0f8f0b58971fa1643806b980ea3894"></a><br/></td></tr>
129
<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>
130
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the fade out time for this popup menu. <a href="#a3764970515789f7ab0daef43ca1b1d53"></a><br/></td></tr>
131
<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>
132
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tells the popup menu to open. <a href="#afa868e767bd5616467763da15d48f145"></a><br/></td></tr>
133
<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>
134
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tells the popup menu to close. <a href="#ae64f527a32e6330fda84379f4561ec3a"></a><br/></td></tr>
135
<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)" -->
136
 </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>
137
<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>
138
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75722c54c391431c4fdb9ea0d1f5ea11"></a><!-- doxytag: member="CEGUI::PopupMenu::~PopupMenu" ref="a75722c54c391431c4fdb9ea0d1f5ea11" args="(void)" -->
139
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a75722c54c391431c4fdb9ea0d1f5ea11">~PopupMenu</a> (void)</td></tr>
140
<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>
141
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
142
Static Public Attributes</h2></td></tr>
143
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44e0c3b6bb8c55775c662d63eb982fb6"></a><!-- doxytag: member="CEGUI::PopupMenu::EventNamespace" ref="a44e0c3b6bb8c55775c662d63eb982fb6" args="" -->
144
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>
145
<tr><td class="mdescLeft"> </td><td class="mdescRight">Namespace for global events. <br/></td></tr>
146
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af46f6959d25108e2f7d5cb7efc413ed8"></a><!-- doxytag: member="CEGUI::PopupMenu::WidgetTypeName" ref="af46f6959d25108e2f7d5cb7efc413ed8" args="" -->
147
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>
148
<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>
149
<tr><td colspan="2"><h2><a name="pro-methods"></a>
150
Protected Member Functions</h2></td></tr>
151
<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>
152
<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>
153
<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>
154
<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>
155
<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>
156
<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>
157
<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>
158
<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>
159
<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>
160
<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>
161
<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>
162
<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>
163
<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>
164
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called when the window is shown (made visible). <a href="#a4eabeb742bad1ea0f74f7083f560a493"></a><br/></td></tr>
165
<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>
166
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called when the window is hidden. <a href="#a6aaab487dbe0d2e6d90a37e82c5f6ffa"></a><br/></td></tr>
167
<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>
168
<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>
169
<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>
170
<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>
171
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
172
Protected Attributes</h2></td></tr>
173
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27cd2bff52a8ac3ddd175730628114ff"></a><!-- doxytag: member="CEGUI::PopupMenu::d_origAlpha" ref="a27cd2bff52a8ac3ddd175730628114ff" args="" -->
174
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a27cd2bff52a8ac3ddd175730628114ff">d_origAlpha</a></td></tr>
175
<tr><td class="mdescLeft"> </td><td class="mdescRight">The original alpha of this window. <br/></td></tr>
176
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8249cce8f80a6a4ec82bfa734198f6ac"></a><!-- doxytag: member="CEGUI::PopupMenu::d_fadeElapsed" ref="a8249cce8f80a6a4ec82bfa734198f6ac" args="" -->
177
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a8249cce8f80a6a4ec82bfa734198f6ac">d_fadeElapsed</a></td></tr>
178
<tr><td class="mdescLeft"> </td><td class="mdescRight">The time in seconds this popup menu has been fading. <br/></td></tr>
179
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80e4d1f86f3cc065504b12aeae702981"></a><!-- doxytag: member="CEGUI::PopupMenu::d_fadeOutTime" ref="a80e4d1f86f3cc065504b12aeae702981" args="" -->
180
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a80e4d1f86f3cc065504b12aeae702981">d_fadeOutTime</a></td></tr>
181
<tr><td class="mdescLeft"> </td><td class="mdescRight">The time in seconds it takes for this popup menu to fade out. <br/></td></tr>
182
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6e491ca49836bb121d8bc605efdff2c"></a><!-- doxytag: member="CEGUI::PopupMenu::d_fadeInTime" ref="ad6e491ca49836bb121d8bc605efdff2c" args="" -->
183
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#ad6e491ca49836bb121d8bc605efdff2c">d_fadeInTime</a></td></tr>
184
<tr><td class="mdescLeft"> </td><td class="mdescRight">The time in seconds it takes for this popup menu to fade in. <br/></td></tr>
185
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17dcdad4bce5520406e93dca7bc0b42a"></a><!-- doxytag: member="CEGUI::PopupMenu::d_fading" ref="a17dcdad4bce5520406e93dca7bc0b42a" args="" -->
186
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a17dcdad4bce5520406e93dca7bc0b42a">d_fading</a></td></tr>
187
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if this popup menu is fading in/out. false if not <br/></td></tr>
188
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a958d2ef49872a442ca35e858cc9d5dcc"></a><!-- doxytag: member="CEGUI::PopupMenu::d_fadingOut" ref="a958d2ef49872a442ca35e858cc9d5dcc" args="" -->
189
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a958d2ef49872a442ca35e858cc9d5dcc">d_fadingOut</a></td></tr>
190
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if this popup menu is fading out. false if fading in. <br/></td></tr>
191
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38785297f2f0532c6829fe61e69a6821"></a><!-- doxytag: member="CEGUI::PopupMenu::d_isOpen" ref="a38785297f2f0532c6829fe61e69a6821" args="" -->
192
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PopupMenu.html#a38785297f2f0532c6829fe61e69a6821">d_isOpen</a></td></tr>
193
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if this popup menu is open. false if not. <br/></td></tr>
195
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
196
<div class="textblock"><p>Base class for popup menus. </p>
197
</div><hr/><h2>Member Function Documentation</h2>
198
<a class="anchor" id="ae64f527a32e6330fda84379f4561ec3a"></a><!-- doxytag: member="CEGUI::PopupMenu::closePopupMenu" ref="ae64f527a32e6330fda84379f4561ec3a" args="(bool notify=true)" -->
199
<div class="memitem">
200
<div class="memproto">
201
<table class="memname">
203
<td class="memname">void CEGUI::PopupMenu::closePopupMenu </td>
205
<td class="paramtype">bool </td>
206
<td class="paramname"><em>notify</em> = <code>true</code></td><td>)</td>
213
<p>Tells the popup menu to close. </p>
214
<dl><dt><b>Parameters:</b></dt><dd>
215
<table class="params">
216
<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>
223
<a class="anchor" id="a3d96ac686a00cbadf68d42d9ec4d68ff"></a><!-- doxytag: member="CEGUI::PopupMenu::getContentSize" ref="a3d96ac686a00cbadf68d42d9ec4d68ff" args="(void) const " -->
224
<div class="memitem">
225
<div class="memproto">
226
<table class="memname">
228
<td class="memname">virtual <a class="el" href="classCEGUI_1_1Size.html">Size</a> CEGUI::PopupMenu::getContentSize </td>
230
<td class="paramtype">void </td>
231
<td class="paramname"></td><td>)</td>
232
<td> const<code> [protected, virtual]</code></td>
238
<p>Resizes the popup menu to exactly fit the content that is attached to it. </p>
239
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
241
<p>Implements <a class="el" href="classCEGUI_1_1ItemListBase.html#a55be4e05c1e8fecb6af897329f460ed6">CEGUI::ItemListBase</a>.</p>
245
<a class="anchor" id="a8576d52a0428f5a0dcb7c6dfcbf4b636"></a><!-- doxytag: member="CEGUI::PopupMenu::getFadeInTime" ref="a8576d52a0428f5a0dcb7c6dfcbf4b636" args="(void) const " -->
246
<div class="memitem">
247
<div class="memproto">
248
<table class="memname">
250
<td class="memname">float CEGUI::PopupMenu::getFadeInTime </td>
252
<td class="paramtype">void </td>
253
<td class="paramname"></td><td>)</td>
254
<td> const<code> [inline]</code></td>
260
<p>Get the fade in time for this popup menu. </p>
261
<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>
265
<a class="anchor" id="a7a8f38968098ae405e7e8b241327e4de"></a><!-- doxytag: member="CEGUI::PopupMenu::getFadeOutTime" ref="a7a8f38968098ae405e7e8b241327e4de" args="(void) const " -->
266
<div class="memitem">
267
<div class="memproto">
268
<table class="memname">
270
<td class="memname">float CEGUI::PopupMenu::getFadeOutTime </td>
272
<td class="paramtype">void </td>
273
<td class="paramname"></td><td>)</td>
274
<td> const<code> [inline]</code></td>
280
<p>Get the fade out time for this popup menu. </p>
281
<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>
285
<a class="anchor" id="af623844a7a70c77ce37c6c5143f22f2a"></a><!-- doxytag: member="CEGUI::PopupMenu::layoutItemWidgets" ref="af623844a7a70c77ce37c6c5143f22f2a" args="(void)" -->
286
<div class="memitem">
287
<div class="memproto">
288
<table class="memname">
290
<td class="memname">virtual void CEGUI::PopupMenu::layoutItemWidgets </td>
292
<td class="paramtype">void </td>
293
<td class="paramname"></td><td>)</td>
294
<td><code> [protected, virtual]</code></td>
300
<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>
301
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
303
<p>Implements <a class="el" href="classCEGUI_1_1ItemListBase.html#a00677a8723e74b898ba03ee4265d9dcc">CEGUI::ItemListBase</a>.</p>
307
<a class="anchor" id="a3605416ac82133202b5df828b319c11e"></a><!-- doxytag: member="CEGUI::PopupMenu::onAlphaChanged" ref="a3605416ac82133202b5df828b319c11e" args="(WindowEventArgs &e)" -->
308
<div class="memitem">
309
<div class="memproto">
310
<table class="memname">
312
<td class="memname">virtual void CEGUI::PopupMenu::onAlphaChanged </td>
314
<td class="paramtype"><a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> & </td>
315
<td class="paramname"><em>e</em></td><td>)</td>
316
<td><code> [protected, virtual]</code></td>
322
<p>Handler called when the window's alpha blend value is changed. </p>
323
<dl><dt><b>Parameters:</b></dt><dd>
324
<table class="params">
325
<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>
330
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#ad67da98096a6e29dd2a029a7d90a1a11">CEGUI::Window</a>.</p>
334
<a class="anchor" id="ada0998b9191a5d137563cb29ac530120"></a><!-- doxytag: member="CEGUI::PopupMenu::onDestructionStarted" ref="ada0998b9191a5d137563cb29ac530120" args="(WindowEventArgs &e)" -->
335
<div class="memitem">
336
<div class="memproto">
337
<table class="memname">
339
<td class="memname">virtual void CEGUI::PopupMenu::onDestructionStarted </td>
341
<td class="paramtype"><a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> & </td>
342
<td class="paramname"><em>e</em></td><td>)</td>
343
<td><code> [protected, virtual]</code></td>
349
<p>Handler called when this window's destruction sequence has begun. </p>
350
<dl><dt><b>Parameters:</b></dt><dd>
351
<table class="params">
352
<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>
357
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a7dfc74e1a9d535b01bee4bc2a4895271">CEGUI::Window</a>.</p>
361
<a class="anchor" id="a6aaab487dbe0d2e6d90a37e82c5f6ffa"></a><!-- doxytag: member="CEGUI::PopupMenu::onHidden" ref="a6aaab487dbe0d2e6d90a37e82c5f6ffa" args="(WindowEventArgs &e)" -->
362
<div class="memitem">
363
<div class="memproto">
364
<table class="memname">
366
<td class="memname">virtual void CEGUI::PopupMenu::onHidden </td>
368
<td class="paramtype"><a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> & </td>
369
<td class="paramname"><em>e</em></td><td>)</td>
370
<td><code> [protected, virtual]</code></td>
376
<p>Handler called when the window is hidden. </p>
377
<dl><dt><b>Parameters:</b></dt><dd>
378
<table class="params">
379
<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>
384
<p>Reimplemented from <a class="el" href="classCEGUI_1_1MenuBase.html#a675b4ffc352e1aa6c4b51cb2729bbbf4">CEGUI::MenuBase</a>.</p>
388
<a class="anchor" id="a6ec7315fc6286603e94fb2490cc5f4e4"></a><!-- doxytag: member="CEGUI::PopupMenu::onMouseButtonDown" ref="a6ec7315fc6286603e94fb2490cc5f4e4" args="(MouseEventArgs &e)" -->
389
<div class="memitem">
390
<div class="memproto">
391
<table class="memname">
393
<td class="memname">virtual void CEGUI::PopupMenu::onMouseButtonDown </td>
395
<td class="paramtype"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> & </td>
396
<td class="paramname"><em>e</em></td><td>)</td>
397
<td><code> [protected, virtual]</code></td>
403
<p>Handler called when a mouse button has been depressed within this window's area. </p>
404
<dl><dt><b>Parameters:</b></dt><dd>
405
<table class="params">
406
<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>
411
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#abb30780cd259d8328df6ff0809f8ce4a">CEGUI::Window</a>.</p>
415
<a class="anchor" id="abd3ab033e849365e83078eb56158a2c0"></a><!-- doxytag: member="CEGUI::PopupMenu::onMouseButtonUp" ref="abd3ab033e849365e83078eb56158a2c0" args="(MouseEventArgs &e)" -->
416
<div class="memitem">
417
<div class="memproto">
418
<table class="memname">
420
<td class="memname">virtual void CEGUI::PopupMenu::onMouseButtonUp </td>
422
<td class="paramtype"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> & </td>
423
<td class="paramname"><em>e</em></td><td>)</td>
424
<td><code> [protected, virtual]</code></td>
430
<p>Handler called when a mouse button has been released within this window's area. </p>
431
<dl><dt><b>Parameters:</b></dt><dd>
432
<table class="params">
433
<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>
438
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#ac03b4971d121ff91d6fc771386029792">CEGUI::Window</a>.</p>
442
<a class="anchor" id="a4eabeb742bad1ea0f74f7083f560a493"></a><!-- doxytag: member="CEGUI::PopupMenu::onShown" ref="a4eabeb742bad1ea0f74f7083f560a493" args="(WindowEventArgs &e)" -->
443
<div class="memitem">
444
<div class="memproto">
445
<table class="memname">
447
<td class="memname">virtual void CEGUI::PopupMenu::onShown </td>
449
<td class="paramtype"><a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> & </td>
450
<td class="paramname"><em>e</em></td><td>)</td>
451
<td><code> [protected, virtual]</code></td>
457
<p>Handler called when the window is shown (made visible). </p>
458
<dl><dt><b>Parameters:</b></dt><dd>
459
<table class="params">
460
<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>
465
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a953eeab59a0091bb2735a8a32decda98">CEGUI::Window</a>.</p>
469
<a class="anchor" id="afa868e767bd5616467763da15d48f145"></a><!-- doxytag: member="CEGUI::PopupMenu::openPopupMenu" ref="afa868e767bd5616467763da15d48f145" args="(bool notify=true)" -->
470
<div class="memitem">
471
<div class="memproto">
472
<table class="memname">
474
<td class="memname">void CEGUI::PopupMenu::openPopupMenu </td>
476
<td class="paramtype">bool </td>
477
<td class="paramname"><em>notify</em> = <code>true</code></td><td>)</td>
484
<p>Tells the popup menu to open. </p>
485
<dl><dt><b>Parameters:</b></dt><dd>
486
<table class="params">
487
<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>
494
<a class="anchor" id="acb0f8f0b58971fa1643806b980ea3894"></a><!-- doxytag: member="CEGUI::PopupMenu::setFadeInTime" ref="acb0f8f0b58971fa1643806b980ea3894" args="(float fadetime)" -->
495
<div class="memitem">
496
<div class="memproto">
497
<table class="memname">
499
<td class="memname">void CEGUI::PopupMenu::setFadeInTime </td>
501
<td class="paramtype">float </td>
502
<td class="paramname"><em>fadetime</em></td><td>)</td>
503
<td><code> [inline]</code></td>
509
<p>Set the fade in time for this popup menu. </p>
510
<dl><dt><b>Parameters:</b></dt><dd>
511
<table class="params">
512
<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>
519
<a class="anchor" id="a3764970515789f7ab0daef43ca1b1d53"></a><!-- doxytag: member="CEGUI::PopupMenu::setFadeOutTime" ref="a3764970515789f7ab0daef43ca1b1d53" args="(float fadetime)" -->
520
<div class="memitem">
521
<div class="memproto">
522
<table class="memname">
524
<td class="memname">void CEGUI::PopupMenu::setFadeOutTime </td>
526
<td class="paramtype">float </td>
527
<td class="paramname"><em>fadetime</em></td><td>)</td>
528
<td><code> [inline]</code></td>
534
<p>Set the fade out time for this popup menu. </p>
535
<dl><dt><b>Parameters:</b></dt><dd>
536
<table class="params">
537
<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>
544
<a class="anchor" id="ad0fbad7b1a623da5c809e5d15e0b58fd"></a><!-- doxytag: member="CEGUI::PopupMenu::testClassName_impl" ref="ad0fbad7b1a623da5c809e5d15e0b58fd" args="(const String &class_name) const " -->
545
<div class="memitem">
546
<div class="memproto">
547
<table class="memname">
549
<td class="memname">virtual bool CEGUI::PopupMenu::testClassName_impl </td>
551
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
552
<td class="paramname"><em>class_name</em></td><td>)</td>
553
<td> const<code> [inline, protected, virtual]</code></td>
559
<p>Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. </p>
560
<dl><dt><b>Parameters:</b></dt><dd>
561
<table class="params">
562
<tr><td class="paramname">class_name</td><td>The class name that is to be checked.</td></tr>
566
<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>
568
<p>Reimplemented from <a class="el" href="classCEGUI_1_1MenuBase.html#a305654b984ca2f384d70f86b07adc6d9">CEGUI::MenuBase</a>.</p>
570
<p>References <a class="el" href="classCEGUI_1_1MenuBase.html#a305654b984ca2f384d70f86b07adc6d9">CEGUI::MenuBase::testClassName_impl()</a>.</p>
574
<a class="anchor" id="a9c68873c4b06781511e01d1a5aeac423"></a><!-- doxytag: member="CEGUI::PopupMenu::updateSelf" ref="a9c68873c4b06781511e01d1a5aeac423" args="(float elapsed)" -->
575
<div class="memitem">
576
<div class="memproto">
577
<table class="memname">
579
<td class="memname">virtual void CEGUI::PopupMenu::updateSelf </td>
581
<td class="paramtype">float </td>
582
<td class="paramname"><em>elapsed</em></td><td>)</td>
583
<td><code> [protected, virtual]</code></td>
589
<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>
590
<dl><dt><b>Parameters:</b></dt><dd>
591
<table class="params">
592
<tr><td class="paramname">elapsed</td><td>float value indicating the number of seconds elapsed since the last update call.</td></tr>
596
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
598
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#af88acbf0fef0d60267500bd3685c5de5">CEGUI::Window</a>.</p>
603
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 for Crazy Eddies GUI System by 
604
<a href="http://www.doxygen.org/index.html">
605
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
added
removed
docs/classCEGUI_1_1PopupMenu.html
