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
|
<!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::ItemEntry 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_1ItemEntry.html">ItemEntry</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">CEGUI::ItemEntry Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::ItemEntry" --><!-- doxytag: inherits="CEGUI::Window" -->
<p>Base class for item type widgets.
<a href="classCEGUI_1_1ItemEntry.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::ItemEntry:</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_1ItemEntry__inherit__graph.gif" border="0" usemap="#CEGUI_1_1ItemEntry_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1ItemEntry_inherit__map" id="CEGUI_1_1ItemEntry_inherit__map">
<area shape="rect" id="node5" href="classCEGUI_1_1MenuItem.html" title="Base class for menu items." alt="" coords="5,160,136,189"/><area shape="rect" id="node2" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv..." alt="" coords="11,5,131,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::ItemEntry:</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_1ItemEntry__coll__graph.gif" border="0" usemap="#CEGUI_1_1ItemEntry_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1ItemEntry_coll__map" id="CEGUI_1_1ItemEntry_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv..." alt="" coords="184,285,304,315"/><area shape="rect" id="node4" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="32,5,138,35"/><area shape="rect" id="node8" href="classCEGUI_1_1ItemEntryProperties_1_1Selected.html" title="Property to access the state of the selected setting." alt="" coords="457,285,705,315"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1ItemEntry-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Size.html">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#afdf8b10bcc5ca180e2fcd8c1816bf5f1">getItemPixelSize</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the "optimal" size for the item. <a href="#afdf8b10bcc5ca180e2fcd8c1816bf5f1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3d2f45d1728895c4cfa692c565df6a6"></a><!-- doxytag: member="CEGUI::ItemEntry::getOwnerList" ref="ad3d2f45d1728895c4cfa692c565df6a6" args="(void) const " -->
<a class="el" href="classCEGUI_1_1ItemListBase.html">ItemListBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#ad3d2f45d1728895c4cfa692c565df6a6">getOwnerList</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the owner <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a>. 0 if there is none. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a174806f216732eb9c6f8a36380a05b26"></a><!-- doxytag: member="CEGUI::ItemEntry::isSelected" ref="a174806f216732eb9c6f8a36380a05b26" args="(void) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#a174806f216732eb9c6f8a36380a05b26">isSelected</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether this item is selected or not. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b18067ec584b150411b3e6ed49a3fec"></a><!-- doxytag: member="CEGUI::ItemEntry::isSelectable" ref="a4b18067ec584b150411b3e6ed49a3fec" args="(void) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#a4b18067ec584b150411b3e6ed49a3fec">isSelectable</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether this item is selectable or not. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#a55690d0bd279385b33f9945a7a531806">setSelected</a> (bool setting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the selection state of this item (on/off). If this item is not selectable this function does nothing. <a href="#a55690d0bd279385b33f9945a7a531806"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc912b8bbedba40a7468fcd7bb607993"></a><!-- doxytag: member="CEGUI::ItemEntry::select" ref="adc912b8bbedba40a7468fcd7bb607993" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#adc912b8bbedba40a7468fcd7bb607993">select</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Selects the item. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8835308921707a2b4c8740e3a04e54c1"></a><!-- doxytag: member="CEGUI::ItemEntry::deselect" ref="a8835308921707a2b4c8740e3a04e54c1" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#a8835308921707a2b4c8740e3a04e54c1">deselect</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deselects the item. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78fac947492c3487231a7572791ee0e3"></a><!-- doxytag: member="CEGUI::ItemEntry::setSelected_impl" ref="a78fac947492c3487231a7572791ee0e3" args="(bool state, bool notify)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#a78fac947492c3487231a7572791ee0e3">setSelected_impl</a> (bool state, bool notify)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the selection state for this ListItem. Internal version. Should NOT be used by client code. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#a521fc31385f64ada467e4b5bfe7a1a83">setSelectable</a> (bool setting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether this item will be selectable. <a href="#a521fc31385f64ada467e4b5bfe7a1a83"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a5fe00024634bd2893aefb4d1669cfd"></a><!-- doxytag: member="CEGUI::ItemEntry::ItemEntry" ref="a7a5fe00024634bd2893aefb4d1669cfd" args="(const String &type, const String &name)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#a7a5fe00024634bd2893aefb4d1669cfd">ItemEntry</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_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> objects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adca71261ed98ff2c9645119f9860705b"></a><!-- doxytag: member="CEGUI::ItemEntry::~ItemEntry" ref="adca71261ed98ff2c9645119f9860705b" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#adca71261ed98ff2c9645119f9860705b">~ItemEntry</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</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="af4dec911d2c51c1941f39783fce4d8ad"></a><!-- doxytag: member="CEGUI::ItemEntry::WidgetTypeName" ref="af4dec911d2c51c1941f39783fce4d8ad" 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_1ItemEntry.html#af4dec911d2c51c1941f39783fce4d8ad">WidgetTypeName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> factory name. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#abc6e1df9a8b1b79407d512867c11f978">EventSelectionChanged</a></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#af93fcbbb43c99b50ae9a4fd6417c51b0">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 the "optimal" size for the item. <a href="#af93fcbbb43c99b50ae9a4fd6417c51b0"></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_1ItemEntry.html#ada2a37efb1bc0cb8d0d48e91a71c1107">validateWindowRenderer</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function used in checking if a <a class="el" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">WindowRenderer</a> is valid for this window. <a href="#ada2a37efb1bc0cb8d0d48e91a71c1107"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1bc1470119254f656d8f2a888bb610dc"></a><!-- doxytag: member="CEGUI::ItemEntry::onSelectionChanged" ref="a1bc1470119254f656d8f2a888bb610dc" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#a1bc1470119254f656d8f2a888bb610dc">onSelectionChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handles selection state changes. <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_1ItemEntry.html#adc21a0ddba98f3485f23ea3a45c31e64">onMouseClicked</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 clicked (that is depressed and then released, within a specified time) within this window's area. <a href="#adc21a0ddba98f3485f23ea3a45c31e64"></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="el" href="classCEGUI_1_1ItemListBase.html">ItemListBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#aac057e5f874ae79e7501bdf1dea99c77">d_ownerList</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">< pointer to the owner <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a>. 0 if there is none. <a href="#aac057e5f874ae79e7501bdf1dea99c77"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7c7be250c6d4b64b946657534b46318"></a><!-- doxytag: member="CEGUI::ItemEntry::d_selected" ref="af7c7be250c6d4b64b946657534b46318" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemEntry.html#af7c7be250c6d4b64b946657534b46318">d_selected</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">'true' when the item is selectable. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae2932c3febd62015c00d7372b938d304"></a><!-- doxytag: member="CEGUI::ItemEntry::d_selectable" ref="ae2932c3febd62015c00d7372b938d304" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>d_selectable</b></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9cf50001089a37b1dae42bd3b9125d5"></a><!-- doxytag: member="CEGUI::ItemEntry::ItemListBase" ref="ac9cf50001089a37b1dae42bd3b9125d5" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>ItemListBase</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class for item type widgets. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>Fire events on selection / deselection. (Maybe selectable mode changed as well?) </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afdf8b10bcc5ca180e2fcd8c1816bf5f1"></a><!-- doxytag: member="CEGUI::ItemEntry::getItemPixelSize" ref="afdf8b10bcc5ca180e2fcd8c1816bf5f1" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Size.html">Size</a> CEGUI::ItemEntry::getItemPixelSize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the "optimal" size for the item. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> describing the size in pixel that this ItemEntry's content requires for non-clipped rendering </dd></dl>
</div>
</div>
<a class="anchor" id="adc21a0ddba98f3485f23ea3a45c31e64"></a><!-- doxytag: member="CEGUI::ItemEntry::onMouseClicked" ref="adc21a0ddba98f3485f23ea3a45c31e64" args="(MouseEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ItemEntry::onMouseClicked </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 clicked (that is depressed and then released, within a specified time) 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#af2554a17ec3165ad2897be69ab3222ac">CEGUI::Window</a>.</p>
</div>
</div>
<a class="anchor" id="a521fc31385f64ada467e4b5bfe7a1a83"></a><!-- doxytag: member="CEGUI::ItemEntry::setSelectable" ref="a521fc31385f64ada467e4b5bfe7a1a83" args="(bool setting)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ItemEntry::setSelectable </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>setting</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets whether this item will be selectable. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">setting</td><td>'true' to allow this item to be selected. 'false' to disallow this item from ever being selected.</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>If the item is currently selectable and selected, calling this function with <em>setting</em> as 'false' will first deselect the item and then disable selectability. </dd></dl>
</div>
</div>
<a class="anchor" id="a55690d0bd279385b33f9945a7a531806"></a><!-- doxytag: member="CEGUI::ItemEntry::setSelected" ref="a55690d0bd279385b33f9945a7a531806" args="(bool setting)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ItemEntry::setSelected </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>setting</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the selection state of this item (on/off). If this item is not selectable this function does nothing. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">setting</td><td>'true' to select the item. 'false' to deselect the item. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af93fcbbb43c99b50ae9a4fd6417c51b0"></a><!-- doxytag: member="CEGUI::ItemEntry::testClassName_impl" ref="af93fcbbb43c99b50ae9a4fd6417c51b0" args="(const String &class_name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::ItemEntry::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 the "optimal" size for the item. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> describing the size in pixel that this ItemEntry's content requires for non-clipped rendering</dd></dl>
<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_1Window.html#a2b58cf00b4790c9cb08acfc18d5d3b0b">CEGUI::Window</a>.</p>
<p>Reimplemented in <a class="el" href="classCEGUI_1_1MenuItem.html#a1390ec335e4b11115b346da3482e72bd">CEGUI::MenuItem</a>.</p>
<p>References <a class="el" href="classCEGUI_1_1Window.html#a2b58cf00b4790c9cb08acfc18d5d3b0b">CEGUI::Window::testClassName_impl()</a>.</p>
<p>Referenced by <a class="el" href="classCEGUI_1_1MenuItem.html#a1390ec335e4b11115b346da3482e72bd">CEGUI::MenuItem::testClassName_impl()</a>.</p>
</div>
</div>
<a class="anchor" id="ada2a37efb1bc0cb8d0d48e91a71c1107"></a><!-- doxytag: member="CEGUI::ItemEntry::validateWindowRenderer" ref="ada2a37efb1bc0cb8d0d48e91a71c1107" args="(const String &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::ItemEntry::validateWindowRenderer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const<code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function used in checking if a <a class="el" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">WindowRenderer</a> is valid for this window. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns true if the given <a class="el" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">WindowRenderer</a> class name is valid for this window. False if not. </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a27804e1e76bbbf4af45dfb23c24afa1a">CEGUI::Window</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aac057e5f874ae79e7501bdf1dea99c77"></a><!-- doxytag: member="CEGUI::ItemEntry::d_ownerList" ref="aac057e5f874ae79e7501bdf1dea99c77" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1ItemListBase.html">ItemListBase</a>* <a class="el" href="classCEGUI_1_1ItemEntry.html#aac057e5f874ae79e7501bdf1dea99c77">CEGUI::ItemEntry::d_ownerList</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>< pointer to the owner <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a>. 0 if there is none. </p>
<p>'true' when the item is in the selected state, 'false' if not. </p>
</div>
</div>
<a class="anchor" id="abc6e1df9a8b1b79407d512867c11f978"></a><!-- doxytag: member="CEGUI::ItemEntry::EventSelectionChanged" ref="abc6e1df9a8b1b79407d512867c11f978" 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_1ItemEntry.html#abc6e1df9a8b1b79407d512867c11f978">CEGUI::ItemEntry::EventSelectionChanged</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> fired when the item's selection state changes. Handlers are passed a const <a class="el" href="classCEGUI_1_1WindowEventArgs.html" title="EventArgs based class that is used for objects passed to handlers triggered for events concerning som...">WindowEventArgs</a> reference with <a class="el" href="classCEGUI_1_1WindowEventArgs.html#a5817b522882b9648d445a20b8c354966" title="pointer to a Window object of relevance to the event.">WindowEventArgs::window</a> set to the <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> whose selection state has changed. </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|