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
|
<!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::PropertyLinkDefinition 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_1PropertyLinkDefinition.html">PropertyLinkDefinition</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-types">Protected Types</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::PropertyLinkDefinition Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::PropertyLinkDefinition" --><!-- doxytag: inherits="CEGUI::PropertyDefinitionBase" -->
<p>Class representing a property that links to another property defined on an attached child widget.
<a href="classCEGUI_1_1PropertyLinkDefinition.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::PropertyLinkDefinition:</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_1PropertyLinkDefinition__inherit__graph.gif" border="0" usemap="#CEGUI_1_1PropertyLinkDefinition_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1PropertyLinkDefinition_inherit__map" id="CEGUI_1_1PropertyLinkDefinition_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1PropertyDefinitionBase.html" title="common base class used for types representing a new property to be available on all widgets that use ..." alt="" coords="5,83,211,112"/><area shape="rect" id="node4" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name." alt="" coords="47,5,169,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::PropertyLinkDefinition:</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_1PropertyLinkDefinition__coll__graph.gif" border="0" usemap="#CEGUI_1_1PropertyLinkDefinition_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1PropertyLinkDefinition_coll__map" id="CEGUI_1_1PropertyLinkDefinition_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1PropertyDefinitionBase.html" title="common base class used for types representing a new property to be available on all widgets that use ..." alt="" coords="5,216,211,245"/><area shape="rect" id="node4" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name." alt="" coords="47,136,169,165"/><area shape="rect" id="node6" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="55,5,161,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1PropertyLinkDefinition-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structCEGUI_1_1PropertyLinkDefinition_1_1LinkTarget.html">LinkTarget</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal struct used to keep track of targets. <a href="structCEGUI_1_1PropertyLinkDefinition_1_1LinkTarget.html#details">More...</a><br/></td></tr>
<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="anchor" id="a1d20ad534401455b0fa30716d6f2b774"></a><!-- doxytag: member="CEGUI::PropertyLinkDefinition::PropertyLinkDefinition" ref="a1d20ad534401455b0fa30716d6f2b774" args="(const String &propertyName, const String &widgetNameSuffix, const String &targetProperty, const String &initialValue, bool redrawOnWrite, bool layoutOnWrite)" -->
 </td><td class="memItemRight" valign="bottom"><b>PropertyLinkDefinition</b> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &propertyName, const <a class="el" href="classCEGUI_1_1String.html">String</a> &widgetNameSuffix, const <a class="el" href="classCEGUI_1_1String.html">String</a> &targetProperty, const <a class="el" href="classCEGUI_1_1String.html">String</a> &initialValue, bool redrawOnWrite, bool layoutOnWrite)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0c225ac5666a73165326d2f02e9548a"></a><!-- doxytag: member="CEGUI::PropertyLinkDefinition::addLinkTarget" ref="aa0c225ac5666a73165326d2f02e9548a" args="(const String &widget, const String &property)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertyLinkDefinition.html#aa0c225ac5666a73165326d2f02e9548a">addLinkTarget</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &widget, const <a class="el" href="classCEGUI_1_1String.html">String</a> &property)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">add a new link target to <em>property</em> on <em>widget</em> (name suffix). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0fb927ddc28f29415dfc42ae4e49331d"></a><!-- doxytag: member="CEGUI::PropertyLinkDefinition::clearLinkTargets" ref="a0fb927ddc28f29415dfc42ae4e49331d" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertyLinkDefinition.html#a0fb927ddc28f29415dfc42ae4e49331d">clearLinkTargets</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">clear all link targets from this link definition. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertyLinkDefinition.html#a0a0c26e97cf4fe966b823580d925ae1f">get</a> (const <a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> *receiver) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current value of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> as a <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>. <a href="#a0a0c26e97cf4fe966b823580d925ae1f"></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_1PropertyLinkDefinition.html#acba8ffcaaed43976c7024e115045311c">set</a> (<a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> *receiver, const <a class="el" href="classCEGUI_1_1String.html">String</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the value of the property. <a href="#acba8ffcaaed43976c7024e115045311c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a800902338f5ef11260804bc1945a897c"></a><!-- doxytag: member="CEGUI::PropertyLinkDefinition::LinkTargetCollection" ref="a800902338f5ef11260804bc1945a897c" args="" -->
typedef std::vector< <a class="el" href="structCEGUI_1_1PropertyLinkDefinition_1_1LinkTarget.html">LinkTarget</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertyLinkDefinition.html#a800902338f5ef11260804bc1945a897c">LinkTargetCollection</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">type used for the collection of targets. <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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertyLinkDefinition.html#ac908c7dc874db815d912939019c0130c">writeXMLElementType</a> (<a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> &xml_stream) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write out the text of the XML element type. Note that you should not write the opening '<' character, nor any other information such as attributes in this function. The writeExtraAttributes function can be used for writing attributes. <a href="#ac908c7dc874db815d912939019c0130c"></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_1PropertyLinkDefinition.html#a3abd9e526648abc9814f771b8e6e8cda">writeXMLAttributes</a> (<a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> &xml_stream) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write out any xml attributes added in a sub-class. Note that you should not write the closing '/>' character sequence, nor any other information in this function. You should always call the base class implementation of this function when overriding. <a href="#a3abd9e526648abc9814f771b8e6e8cda"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1Window.html">Window</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertyLinkDefinition.html#af12265bad8b6eecb57ac81bc0f128866">getTargetWindow</a> (const <a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> *receiver) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return a pointer to the window containing the target property to be accessed. <a href="#af12265bad8b6eecb57ac81bc0f128866"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Window.html">Window</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertyLinkDefinition.html#a7c0ba55b0332a21f727efe5bfb726d3a">getTargetWindow</a> (<a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> *receiver)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a816ec91c48481e0735f64247f96ee834"></a><!-- doxytag: member="CEGUI::PropertyLinkDefinition::getTargetWindow" ref="a816ec91c48481e0735f64247f96ee834" args="(const PropertyReceiver *receiver, const String &name_suffix) const " -->
const <a class="el" href="classCEGUI_1_1Window.html">Window</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertyLinkDefinition.html#a816ec91c48481e0735f64247f96ee834">getTargetWindow</a> (const <a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> *receiver, const <a class="el" href="classCEGUI_1_1String.html">String</a> &name_suffix) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the target window with the given suffix. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0711d24781cc1a32100980d8303329e6"></a><!-- doxytag: member="CEGUI::PropertyLinkDefinition::getTargetWindow" ref="a0711d24781cc1a32100980d8303329e6" args="(PropertyReceiver *receiver, const String &name_suffix)" -->
<a class="el" href="classCEGUI_1_1Window.html">Window</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertyLinkDefinition.html#a0711d24781cc1a32100980d8303329e6">getTargetWindow</a> (<a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> *receiver, const <a class="el" href="classCEGUI_1_1String.html">String</a> &name_suffix)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the target window with the given suffix. <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="a537837aa72442225157b0db7fff9e0a0"></a><!-- doxytag: member="CEGUI::PropertyLinkDefinition::d_targets" ref="a537837aa72442225157b0db7fff9e0a0" args="" -->
<a class="el" href="classCEGUI_1_1PropertyLinkDefinition.html#a800902338f5ef11260804bc1945a897c">LinkTargetCollection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertyLinkDefinition.html#a537837aa72442225157b0db7fff9e0a0">d_targets</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">collection of targets for this <a class="el" href="classCEGUI_1_1PropertyLinkDefinition.html" title="Class representing a property that links to another property defined on an attached child widget...">PropertyLinkDefinition</a>. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class representing a property that links to another property defined on an attached child widget. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0a0c26e97cf4fe966b823580d925ae1f"></a><!-- doxytag: member="CEGUI::PropertyLinkDefinition::get" ref="a0a0c26e97cf4fe966b823580d925ae1f" args="(const PropertyReceiver *receiver) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1String.html">String</a> CEGUI::PropertyLinkDefinition::get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> * </td>
<td class="paramname"><em>receiver</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the current value of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> as a <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">receiver</td><td>Pointer to the target object.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing a textual representation of the current value of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1Property.html#a47b2146f07d6a725075d06dc62396ab1">CEGUI::Property</a>.</p>
</div>
</div>
<a class="anchor" id="a7c0ba55b0332a21f727efe5bfb726d3a"></a><!-- doxytag: member="CEGUI::PropertyLinkDefinition::getTargetWindow" ref="a7c0ba55b0332a21f727efe5bfb726d3a" args="(PropertyReceiver *receiver)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Window.html">Window</a>* CEGUI::PropertyLinkDefinition::getTargetWindow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> * </td>
<td class="paramname"><em>receiver</em></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd>This will be removed in 0.8.x. Use the version taking a suffix string instead! </dd></dl>
</div>
</div>
<a class="anchor" id="af12265bad8b6eecb57ac81bc0f128866"></a><!-- doxytag: member="CEGUI::PropertyLinkDefinition::getTargetWindow" ref="af12265bad8b6eecb57ac81bc0f128866" args="(const PropertyReceiver *receiver) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1Window.html">Window</a>* CEGUI::PropertyLinkDefinition::getTargetWindow </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> * </td>
<td class="paramname"><em>receiver</em></td><td>)</td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return a pointer to the window containing the target property to be accessed. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1UnknownObjectException.html" title="Exception class used when a request was made for an unknown object.">UnknownObjectException</a></td><td>thrown if no such target window exists within the system.</td></tr>
</table>
</dd>
</dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000007">Deprecated:</a></b></dt><dd>This will be removed in 0.8.x. Use the version taking a suffix string instead! </dd></dl>
</div>
</div>
<a class="anchor" id="acba8ffcaaed43976c7024e115045311c"></a><!-- doxytag: member="CEGUI::PropertyLinkDefinition::set" ref="acba8ffcaaed43976c7024e115045311c" args="(PropertyReceiver *receiver, const String &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::PropertyLinkDefinition::set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1PropertyReceiver.html">PropertyReceiver</a> * </td>
<td class="paramname"><em>receiver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the value of the property. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>When overriding the <a class="el" href="classCEGUI_1_1PropertyLinkDefinition.html#acba8ffcaaed43976c7024e115045311c" title="Sets the value of the property.">set()</a> member of <a class="el" href="classCEGUI_1_1PropertyDefinitionBase.html" title="common base class used for types representing a new property to be available on all widgets that use ...">PropertyDefinitionBase</a>, you MUST call the base class implementation after you have set the property value (i.e. you must call <a class="el" href="classCEGUI_1_1PropertyDefinitionBase.html#a1810c470e93435ffc3767cd7cb9d4f71" title="Sets the value of the property.">PropertyDefinitionBase::set()</a>).</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">receiver</td><td>Pointer to the target object.</td></tr>
<tr><td class="paramname">value</td><td>A <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object that contains a textual representation of the new value to assign to the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1InvalidRequestException.html" title="Exception class used when some impossible request was made of the system.">InvalidRequestException</a></td><td>Thrown when the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> was unable to interpret the content of <em>value</em>. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1PropertyDefinitionBase.html#a1810c470e93435ffc3767cd7cb9d4f71">CEGUI::PropertyDefinitionBase</a>.</p>
</div>
</div>
<a class="anchor" id="a3abd9e526648abc9814f771b8e6e8cda"></a><!-- doxytag: member="CEGUI::PropertyLinkDefinition::writeXMLAttributes" ref="a3abd9e526648abc9814f771b8e6e8cda" args="(XMLSerializer &xml_stream) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::PropertyLinkDefinition::writeXMLAttributes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> & </td>
<td class="paramname"><em>xml_stream</em></td><td>)</td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write out any xml attributes added in a sub-class. Note that you should not write the closing '/>' character sequence, nor any other information in this function. You should always call the base class implementation of this function when overriding. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">xml_stream</td><td>Stream where xml data should be output. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1PropertyDefinitionBase.html#a76081d3caf2c2821e23edf4654b63825">CEGUI::PropertyDefinitionBase</a>.</p>
</div>
</div>
<a class="anchor" id="ac908c7dc874db815d912939019c0130c"></a><!-- doxytag: member="CEGUI::PropertyLinkDefinition::writeXMLElementType" ref="ac908c7dc874db815d912939019c0130c" args="(XMLSerializer &xml_stream) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::PropertyLinkDefinition::writeXMLElementType </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> & </td>
<td class="paramname"><em>xml_stream</em></td><td>)</td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write out the text of the XML element type. Note that you should not write the opening '<' character, nor any other information such as attributes in this function. The writeExtraAttributes function can be used for writing attributes. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">xml_stream</td><td>Stream where xml data should be output. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classCEGUI_1_1PropertyDefinitionBase.html#a5d91ae077fa2bebc0c83134670e112e1">CEGUI::PropertyDefinitionBase</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 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>
|