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
|
<!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::FalagardProgressBar 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_1FalagardProgressBar.html">FalagardProgressBar</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::FalagardProgressBar Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::FalagardProgressBar" --><!-- doxytag: inherits="CEGUI::WindowRenderer" -->
<p><a class="el" href="classCEGUI_1_1ProgressBar.html" title="Base class for progress bars.">ProgressBar</a> class for the FalagardBase module.
<a href="classCEGUI_1_1FalagardProgressBar.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::FalagardProgressBar:</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_1FalagardProgressBar__inherit__graph.gif" border="0" usemap="#CEGUI_1_1FalagardProgressBar_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1FalagardProgressBar_inherit__map" id="CEGUI_1_1FalagardProgressBar_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object." alt="" coords="16,5,189,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::FalagardProgressBar:</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_1FalagardProgressBar__coll__graph.gif" border="0" usemap="#CEGUI_1_1FalagardProgressBar_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1FalagardProgressBar_coll__map" id="CEGUI_1_1FalagardProgressBar_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object." alt="" coords="104,5,277,35"/><area shape="rect" id="node4" href="classCEGUI_1_1FalagardProgressBarProperties_1_1VerticalProgress.html" title="Property to access the setting that controls whether the progress bar is horizontal or vertical..." alt="" coords="12,59,369,88"/><area shape="rect" id="node6" href="classCEGUI_1_1FalagardProgressBarProperties_1_1ReversedProgress.html" title="Property to access the setting that controls the direction that progress 'grows' towards." alt="" coords="5,112,376,141"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1FalagardProgressBar-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_1FalagardProgressBar.html#a513d59fd8e14f5652292e291ee914cb8">FalagardProgressBar</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="#a513d59fd8e14f5652292e291ee914cb8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1701480f3a3684b670d812fcefeace18"></a><!-- doxytag: member="CEGUI::FalagardProgressBar::isVertical" ref="a1701480f3a3684b670d812fcefeace18" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><b>isVertical</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7fd2c6e0a806eece2b58b78a6bdaa25"></a><!-- doxytag: member="CEGUI::FalagardProgressBar::isReversed" ref="ae7fd2c6e0a806eece2b58b78a6bdaa25" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><b>isReversed</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc9ab8f37b31b7301194b9d4eee35ed2"></a><!-- doxytag: member="CEGUI::FalagardProgressBar::setVertical" ref="acc9ab8f37b31b7301194b9d4eee35ed2" args="(bool setting)" -->
void </td><td class="memItemRight" valign="bottom"><b>setVertical</b> (bool setting)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2734e71e44ab6266c591e3a2b8000d7c"></a><!-- doxytag: member="CEGUI::FalagardProgressBar::setReversed" ref="a2734e71e44ab6266c591e3a2b8000d7c" args="(bool setting)" -->
void </td><td class="memItemRight" valign="bottom"><b>setReversed</b> (bool setting)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardProgressBar.html#a7f6590081a688dec8af7f3f1bffd2d24">render</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Populate render cache. <a href="#a7f6590081a688dec8af7f3f1bffd2d24"></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="aef07f238979d3aa970bd9ecbd93bb643"></a><!-- doxytag: member="CEGUI::FalagardProgressBar::TypeName" ref="aef07f238979d3aa970bd9ecbd93bb643" 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="a95c9a223ef4da4ee0d34a0a28de41dae"></a><!-- doxytag: member="CEGUI::FalagardProgressBar::d_vertical" ref="a95c9a223ef4da4ee0d34a0a28de41dae" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardProgressBar.html#a95c9a223ef4da4ee0d34a0a28de41dae">d_vertical</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">True if progress bar operates on the vertical plane. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ce2556c78e526929e0b9bc25e9a2edb"></a><!-- doxytag: member="CEGUI::FalagardProgressBar::d_reversed" ref="a3ce2556c78e526929e0b9bc25e9a2edb" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardProgressBar.html#a3ce2556c78e526929e0b9bc25e9a2edb">d_reversed</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">True if progress grows in the opposite direction to usual (i.e. to the left / downwards). <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="a4f73490c747f508a63e890dd257bcca4"></a><!-- doxytag: member="CEGUI::FalagardProgressBar::d_verticalProperty" ref="a4f73490c747f508a63e890dd257bcca4" args="" -->
static <br class="typebreak"/>
<a class="el" href="classCEGUI_1_1FalagardProgressBarProperties_1_1VerticalProgress.html">FalagardProgressBarProperties::VerticalProgress</a> </td><td class="memItemRight" valign="bottom"><b>d_verticalProperty</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2090195f7c264e3e57e8c7a4d10fb90e"></a><!-- doxytag: member="CEGUI::FalagardProgressBar::d_reversedProperty" ref="a2090195f7c264e3e57e8c7a4d10fb90e" args="" -->
static <br class="typebreak"/>
<a class="el" href="classCEGUI_1_1FalagardProgressBarProperties_1_1ReversedProgress.html">FalagardProgressBarProperties::ReversedProgress</a> </td><td class="memItemRight" valign="bottom"><b>d_reversedProperty</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCEGUI_1_1ProgressBar.html" title="Base class for progress bars.">ProgressBar</a> 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</li>
<li>Disabled</li>
<li>EnabledProgress</li>
<li>DisabledProgress</li>
</ul>
<p>Named Areas:</p>
<ul>
<li>ProgressArea</li>
</ul>
<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> initialiser definitions:</p>
<ul>
<li>VerticalProgress - boolean property. Determines whether the progress widget is horizontal or vertical. Default is horizontal. Optional.</li>
</ul>
<ul>
<li>ReversedProgress - boolean property. Determines whether the progress grows in the opposite direction to what is considered 'usual'. Set to "True" to have progress grow towards the left or bottom of the progress area. Optional. </li>
</ul>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a513d59fd8e14f5652292e291ee914cb8"></a><!-- doxytag: member="CEGUI::FalagardProgressBar::FalagardProgressBar" ref="a513d59fd8e14f5652292e291ee914cb8" args="(const String &type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::FalagardProgressBar::FalagardProgressBar </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="a7f6590081a688dec8af7f3f1bffd2d24"></a><!-- doxytag: member="CEGUI::FalagardProgressBar::render" ref="a7f6590081a688dec8af7f3f1bffd2d24" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardProgressBar::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>
</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>
|
