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
|
<!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::FrameWindowProperties::FrameEnabled 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="namespaceCEGUI_1_1FrameWindowProperties.html">FrameWindowProperties</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1FrameWindowProperties_1_1FrameEnabled.html">FrameEnabled</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::FrameWindowProperties::FrameEnabled Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::FrameWindowProperties::FrameEnabled" --><!-- doxytag: inherits="CEGUI::Property" -->
<p><a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> to access the setting for whether the window frame will be displayed.
<a href="classCEGUI_1_1FrameWindowProperties_1_1FrameEnabled.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::FrameWindowProperties::FrameEnabled:</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_1FrameWindowProperties_1_1FrameEnabled__inherit__graph.gif" border="0" usemap="#CEGUI_1_1FrameWindowProperties_1_1FrameEnabled_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1FrameWindowProperties_1_1FrameEnabled_inherit__map" id="CEGUI_1_1FrameWindowProperties_1_1FrameEnabled_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name." alt="" coords="97,5,220,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::FrameWindowProperties::FrameEnabled:</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_1FrameWindowProperties_1_1FrameEnabled__coll__graph.gif" border="0" usemap="#CEGUI_1_1FrameWindowProperties_1_1FrameEnabled_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1FrameWindowProperties_1_1FrameEnabled_coll__map" id="CEGUI_1_1FrameWindowProperties_1_1FrameEnabled_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name." alt="" coords="97,136,220,165"/><area shape="rect" id="node4" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="105,5,212,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1FrameWindowProperties_1_1FrameEnabled-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_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FrameWindowProperties_1_1FrameEnabled.html#adda3a329d73d85ba29d5a8034dce46f6">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="#adda3a329d73d85ba29d5a8034dce46f6"></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_1FrameWindowProperties_1_1FrameEnabled.html#a27319f8bcd11a0c273655f9c04cd0a91">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="#a27319f8bcd11a0c273655f9c04cd0a91"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> to access the setting for whether the window frame will be displayed. </p>
<dl class="user"><dt><b>Usage:</b></dt><dd><ul>
<li>Name: <a class="el" href="classCEGUI_1_1FrameWindowProperties_1_1FrameEnabled.html" title="Property to access the setting for whether the window frame will be displayed.">FrameEnabled</a></li>
<li>Format: "[text]".</li>
</ul>
</dd></dl>
<dl class="user"><dt><b>Where [Text] is:</b></dt><dd><ul>
<li>"True" to indicate the windows frame should be displayed.</li>
<li>"False" to indicate the windows frame should not be displayed. </li>
</ul>
</dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="adda3a329d73d85ba29d5a8034dce46f6"></a><!-- doxytag: member="CEGUI::FrameWindowProperties::FrameEnabled::get" ref="adda3a329d73d85ba29d5a8034dce46f6" 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::FrameWindowProperties::FrameEnabled::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="a27319f8bcd11a0c273655f9c04cd0a91"></a><!-- doxytag: member="CEGUI::FrameWindowProperties::FrameEnabled::set" ref="a27319f8bcd11a0c273655f9c04cd0a91" args="(PropertyReceiver *receiver, const String &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FrameWindowProperties::FrameEnabled::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><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>Implements <a class="el" href="classCEGUI_1_1Property.html#a66405360c2f98359dbb90f9700fc8251">CEGUI::Property</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>
|
