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
|
<!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::FalagardStatic 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_1FalagardStatic.html">FalagardStatic</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-attribs">Protected Attributes</a> |
<a href="#pro-static-attribs">Static Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::FalagardStatic Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::FalagardStatic" --><!-- doxytag: inherits="CEGUI::WindowRenderer" -->
<p>Static class for the FalagardBase module.
<a href="classCEGUI_1_1FalagardStatic.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::FalagardStatic:</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_1FalagardStatic__inherit__graph.gif" border="0" usemap="#CEGUI_1_1FalagardStatic_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1FalagardStatic_inherit__map" id="CEGUI_1_1FalagardStatic_inherit__map">
<area shape="rect" id="node5" href="classCEGUI_1_1FalagardStaticImage.html" title="StaticImage class for the FalagardBase module." alt="" coords="5,160,197,189"/><area shape="rect" id="node2" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object." alt="" coords="15,5,188,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::FalagardStatic:</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_1FalagardStatic__coll__graph.gif" border="0" usemap="#CEGUI_1_1FalagardStatic_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1FalagardStatic_coll__map" id="CEGUI_1_1FalagardStatic_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object." alt="" coords="89,5,263,35"/><area shape="rect" id="node4" href="classCEGUI_1_1FalagardStaticProperties_1_1BackgroundEnabled.html" title="Property to access the state of the frame background setting for the FalagardStatic widget..." alt="" coords="7,59,345,88"/><area shape="rect" id="node6" href="classCEGUI_1_1FalagardStaticProperties_1_1FrameEnabled.html" title="Property to access the state of the frame enabled setting for the FalagardStatic widget." alt="" coords="23,112,329,141"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1FalagardStatic-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardStatic.html#a5f6fdb2fd59cc1b6c493dbaa838db769">FalagardStatic</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">type name for this widget. <a href="#a5f6fdb2fd59cc1b6c493dbaa838db769"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardStatic.html#a6279b68f4ee323d4992944bdc4c73fed">isFrameEnabled</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether the frame for this static widget is enabled or disabled. <a href="#a6279b68f4ee323d4992944bdc4c73fed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardStatic.html#a6d9b6a3f25f85b99a385e7ed8c38d17b">isBackgroundEnabled</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether the background for this static widget is enabled to disabled. <a href="#a6d9b6a3f25f85b99a385e7ed8c38d17b"></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_1FalagardStatic.html#ab1edde35f3aa66507f7b57447fbf7174">setFrameEnabled</a> (bool setting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable rendering of the frame for this static widget. <a href="#ab1edde35f3aa66507f7b57447fbf7174"></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_1FalagardStatic.html#a1f84437f21c614039caa353975db514b">setBackgroundEnabled</a> (bool setting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable rendering of the background for this static widget. <a href="#a1f84437f21c614039caa353975db514b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardStatic.html#af7a954733aa528d3dd2dfe20fb59752d">render</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Populate render cache. <a href="#af7a954733aa528d3dd2dfe20fb59752d"></a><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="ad646ae360bb00ab81fcbcda7db92f81c"></a><!-- doxytag: member="CEGUI::FalagardStatic::TypeName" ref="ad646ae360bb00ab81fcbcda7db92f81c" args="[]" -->
static const utf8 </td><td class="memItemRight" valign="bottom"><b>TypeName</b> []</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="a59a6f2c0e987c1a64a5935f36ed004a3"></a><!-- doxytag: member="CEGUI::FalagardStatic::d_frameEnabled" ref="a59a6f2c0e987c1a64a5935f36ed004a3" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardStatic.html#a59a6f2c0e987c1a64a5935f36ed004a3">d_frameEnabled</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">True when the frame is enabled. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50b819bf81600c9b13bfcd46e9290df3"></a><!-- doxytag: member="CEGUI::FalagardStatic::d_backgroundEnabled" ref="a50b819bf81600c9b13bfcd46e9290df3" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardStatic.html#a50b819bf81600c9b13bfcd46e9290df3">d_backgroundEnabled</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true when the background is enabled. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5600bfed7a22cca1869bcc422f04077"></a><!-- doxytag: member="CEGUI::FalagardStatic::d_frameEnabledProperty" ref="af5600bfed7a22cca1869bcc422f04077" args="" -->
static <br class="typebreak"/>
<a class="el" href="classCEGUI_1_1FalagardStaticProperties_1_1FrameEnabled.html">FalagardStaticProperties::FrameEnabled</a> </td><td class="memItemRight" valign="bottom"><b>d_frameEnabledProperty</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35e61b0f552fd29b4062b8dc0c31d03e"></a><!-- doxytag: member="CEGUI::FalagardStatic::d_backgroundEnabledProperty" ref="a35e61b0f552fd29b4062b8dc0c31d03e" args="" -->
static <br class="typebreak"/>
<a class="el" href="classCEGUI_1_1FalagardStaticProperties_1_1BackgroundEnabled.html">FalagardStaticProperties::BackgroundEnabled</a> </td><td class="memItemRight" valign="bottom"><b>d_backgroundEnabledProperty</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Static class for the FalagardBase module. </p>
<p>This class requires LookNFeel to be assigned. The LookNFeel should provide the following:</p>
<p>States:</p>
<ul>
<li>Enabled - basic rendering for enabled state.</li>
<li>Disabled - basic rendering for disabled state.</li>
<li>EnabledFrame - frame rendering for enabled state</li>
<li>DisabledFrame - frame rendering for disabled state.</li>
<li>WithFrameEnabledBackground - backdrop rendering for enabled state with frame enabled.</li>
<li>WithFrameDisabledBackground - backdrop rendering for disabled state with frame enabled.</li>
<li>NoFrameEnabledBackground - backdrop rendering for enabled state with frame disabled.</li>
<li>NoFrameDisabledBackground - backdrop rendering for disabled state with frame disabled. </li>
</ul>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5f6fdb2fd59cc1b6c493dbaa838db769"></a><!-- doxytag: member="CEGUI::FalagardStatic::FalagardStatic" ref="a5f6fdb2fd59cc1b6c493dbaa838db769" args="(const String &type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::FalagardStatic::FalagardStatic </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>type name for this widget. </p>
<p>Constructor </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6d9b6a3f25f85b99a385e7ed8c38d17b"></a><!-- doxytag: member="CEGUI::FalagardStatic::isBackgroundEnabled" ref="a6d9b6a3f25f85b99a385e7ed8c38d17b" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::FalagardStatic::isBackgroundEnabled </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether the background for this static widget is enabled to disabled. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the background is enabled and will be rendered. false if the background is disabled and will not be rendered. </dd></dl>
</div>
</div>
<a class="anchor" id="a6279b68f4ee323d4992944bdc4c73fed"></a><!-- doxytag: member="CEGUI::FalagardStatic::isFrameEnabled" ref="a6279b68f4ee323d4992944bdc4c73fed" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::FalagardStatic::isFrameEnabled </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether the frame for this static widget is enabled or disabled. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the frame is enabled and will be rendered. false is the frame is disabled and will not be rendered. </dd></dl>
</div>
</div>
<a class="anchor" id="af7a954733aa528d3dd2dfe20fb59752d"></a><!-- doxytag: member="CEGUI::FalagardStatic::render" ref="af7a954733aa528d3dd2dfe20fb59752d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::FalagardStatic::render </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Populate render cache. </p>
<p>This method must be implemented by all window renderers and should perform the rendering operations needed for this widget. Normally using the Falagard API... </p>
<p>Implements <a class="el" href="classCEGUI_1_1WindowRenderer.html#aafeb7dd00fe1e81f640fac257946ee66">CEGUI::WindowRenderer</a>.</p>
<p>Reimplemented in <a class="el" href="classCEGUI_1_1FalagardStaticImage.html#ac4db89847521cb4813456bda406ccf6d">CEGUI::FalagardStaticImage</a>, and <a class="el" href="classCEGUI_1_1FalagardStaticText.html#abb41d744714ad123eb97e99521022643">CEGUI::FalagardStaticText</a>.</p>
</div>
</div>
<a class="anchor" id="a1f84437f21c614039caa353975db514b"></a><!-- doxytag: member="CEGUI::FalagardStatic::setBackgroundEnabled" ref="a1f84437f21c614039caa353975db514b" args="(bool setting)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardStatic::setBackgroundEnabled </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>Enable or disable rendering of the background for this static widget. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">setting</td><td>true to enable rendering of the background. false to disable rendering of the background. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab1edde35f3aa66507f7b57447fbf7174"></a><!-- doxytag: member="CEGUI::FalagardStatic::setFrameEnabled" ref="ab1edde35f3aa66507f7b57447fbf7174" args="(bool setting)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardStatic::setFrameEnabled </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>Enable or disable rendering of the frame for this static widget. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">setting</td><td>true to enable rendering of a frame. false to disable rendering of a frame. </td></tr>
</table>
</dd>
</dl>
</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>
|
