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
|
<!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: CEGUIProgressBar.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">CEGUIProgressBar.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***********************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> filename: CEGUIProgressBar.h</span>
<a name="l00003"></a>00003 <span class="comment"> created: 13/4/2004</span>
<a name="l00004"></a>00004 <span class="comment"> author: Paul D Turner</span>
<a name="l00005"></a>00005 <span class="comment"> </span>
<a name="l00006"></a>00006 <span class="comment"> purpose: Interface to base class for ProgressBar widget</span>
<a name="l00007"></a>00007 <span class="comment">*************************************************************************/</span>
<a name="l00008"></a>00008 <span class="comment">/***************************************************************************</span>
<a name="l00009"></a>00009 <span class="comment"> * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining</span>
<a name="l00012"></a>00012 <span class="comment"> * a copy of this software and associated documentation files (the</span>
<a name="l00013"></a>00013 <span class="comment"> * "Software"), to deal in the Software without restriction, including</span>
<a name="l00014"></a>00014 <span class="comment"> * without limitation the rights to use, copy, modify, merge, publish,</span>
<a name="l00015"></a>00015 <span class="comment"> * distribute, sublicense, and/or sell copies of the Software, and to</span>
<a name="l00016"></a>00016 <span class="comment"> * permit persons to whom the Software is furnished to do so, subject to</span>
<a name="l00017"></a>00017 <span class="comment"> * the following conditions:</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> * The above copyright notice and this permission notice shall be</span>
<a name="l00020"></a>00020 <span class="comment"> * included in all copies or substantial portions of the Software.</span>
<a name="l00021"></a>00021 <span class="comment"> *</span>
<a name="l00022"></a>00022 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
<a name="l00023"></a>00023 <span class="comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<a name="l00024"></a>00024 <span class="comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span>
<a name="l00025"></a>00025 <span class="comment"> * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR</span>
<a name="l00026"></a>00026 <span class="comment"> * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,</span>
<a name="l00027"></a>00027 <span class="comment"> * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR</span>
<a name="l00028"></a>00028 <span class="comment"> * OTHER DEALINGS IN THE SOFTWARE.</span>
<a name="l00029"></a>00029 <span class="comment"> ***************************************************************************/</span>
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef _CEGUIProgressBar_h_</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define _CEGUIProgressBar_h_</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "../CEGUIBase.h"</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "../CEGUIWindow.h"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "CEGUIProgressBarProperties.h"</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="preprocessor">#if defined(_MSC_VER)</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(push)</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(disable : 4251)</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span>
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="comment">// Start of CEGUI namespace section</span>
<a name="l00045"></a>00045 <span class="keyword">namespace </span>CEGUI
<a name="l00046"></a>00046 {
<a name="l00051"></a><a class="code" href="classCEGUI_1_1ProgressBar.html">00051</a> <span class="keyword">class </span>CEGUIEXPORT <a class="code" href="classCEGUI_1_1ProgressBar.html" title="Base class for progress bars.">ProgressBar</a> : <span class="keyword">public</span> <a class="code" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a>
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053 <span class="keyword">public</span>:
<a name="l00054"></a><a class="code" href="classCEGUI_1_1ProgressBar.html#a4d37209d1c18d025e2ef6bde0104640f">00054</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> <a class="code" href="classCEGUI_1_1ProgressBar.html#a4d37209d1c18d025e2ef6bde0104640f" title="Namespace for global events.">EventNamespace</a>;
<a name="l00055"></a><a class="code" href="classCEGUI_1_1ProgressBar.html#a25ec4ed2edd60a47b705e91a1b6484a9">00055</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> <a class="code" href="classCEGUI_1_1ProgressBar.html#a25ec4ed2edd60a47b705e91a1b6484a9" title="Window factory name.">WidgetTypeName</a>;
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="comment">/*************************************************************************</span>
<a name="l00058"></a>00058 <span class="comment"> Event name constants</span>
<a name="l00059"></a>00059 <span class="comment"> *************************************************************************/</span>
<a name="l00065"></a><a class="code" href="classCEGUI_1_1ProgressBar.html#a5aad8bff364a17b36a6445bfd254aa84">00065</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> <a class="code" href="classCEGUI_1_1ProgressBar.html#a5aad8bff364a17b36a6445bfd254aa84">EventProgressChanged</a>;
<a name="l00071"></a><a class="code" href="classCEGUI_1_1ProgressBar.html#aea074ee2b33f75119fa4409cb9721217">00071</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> <a class="code" href="classCEGUI_1_1ProgressBar.html#aea074ee2b33f75119fa4409cb9721217">EventProgressDone</a>;
<a name="l00072"></a>00072
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="comment">/************************************************************************</span>
<a name="l00075"></a>00075 <span class="comment"> Accessor Functions</span>
<a name="l00076"></a>00076 <span class="comment"> ************************************************************************/</span>
<a name="l00081"></a><a class="code" href="classCEGUI_1_1ProgressBar.html#adab0789746c01f8149d37613cac5b1fb">00081</a> <span class="keywordtype">float</span> <a class="code" href="classCEGUI_1_1ProgressBar.html#adab0789746c01f8149d37613cac5b1fb" title="return the current progress value">getProgress</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{<span class="keywordflow">return</span> d_progress;}
<a name="l00082"></a>00082
<a name="l00087"></a><a class="code" href="classCEGUI_1_1ProgressBar.html#aa3f93faad6cca8d1a522ed1813cac8d4">00087</a> <span class="keywordtype">float</span> <a class="code" href="classCEGUI_1_1ProgressBar.html#aa3f93faad6cca8d1a522ed1813cac8d4" title="return the current step size">getStep</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{<span class="keywordflow">return</span> d_step;}
<a name="l00088"></a>00088
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="comment">/*************************************************************************</span>
<a name="l00091"></a>00091 <span class="comment"> Manipulator Functions</span>
<a name="l00092"></a>00092 <span class="comment"> *************************************************************************/</span>
<a name="l00103"></a>00103 <span class="keywordtype">void</span> setProgress(<span class="keywordtype">float</span> progress);
<a name="l00104"></a>00104
<a name="l00105"></a>00105
<a name="l00116"></a><a class="code" href="classCEGUI_1_1ProgressBar.html#a636c435ce02bbbd6858888a763084f34">00116</a> <span class="keywordtype">void</span> <a class="code" href="classCEGUI_1_1ProgressBar.html#a636c435ce02bbbd6858888a763084f34" title="set the size of the 'step' in percentage points (default is 0.01f or 1%).">setStepSize</a>(<span class="keywordtype">float</span> step_val) {d_step = step_val;}
<a name="l00117"></a>00117
<a name="l00118"></a>00118
<a name="l00129"></a><a class="code" href="classCEGUI_1_1ProgressBar.html#a983e377d100e7ad13bcb8d99896a13a1">00129</a> <span class="keywordtype">void</span> <a class="code" href="classCEGUI_1_1ProgressBar.html#a983e377d100e7ad13bcb8d99896a13a1" title="cause the progress to step">step</a>(<span class="keywordtype">void</span>) {setProgress(d_progress + d_step);}
<a name="l00130"></a>00130
<a name="l00131"></a>00131
<a name="l00143"></a><a class="code" href="classCEGUI_1_1ProgressBar.html#a1910cc699c3909a848b9384e1c40b536">00143</a> <span class="keywordtype">void</span> <a class="code" href="classCEGUI_1_1ProgressBar.html#a1910cc699c3909a848b9384e1c40b536" title="Modify the progress level by a specified delta.">adjustProgress</a>(<span class="keywordtype">float</span> delta) {setProgress(d_progress + delta);}
<a name="l00144"></a>00144
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="comment">/*************************************************************************</span>
<a name="l00147"></a>00147 <span class="comment"> Construction / Destruction</span>
<a name="l00148"></a>00148 <span class="comment"> *************************************************************************/</span>
<a name="l00153"></a>00153 <a class="code" href="classCEGUI_1_1ProgressBar.html" title="Base class for progress bars.">ProgressBar</a>(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& type, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& name);
<a name="l00154"></a>00154
<a name="l00155"></a>00155
<a name="l00160"></a>00160 <span class="keyword">virtual</span> ~<a class="code" href="classCEGUI_1_1ProgressBar.html" title="Base class for progress bars.">ProgressBar</a>(<span class="keywordtype">void</span>);
<a name="l00161"></a>00161
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="keyword">protected</span>:
<a name="l00164"></a>00164 <span class="comment">/*************************************************************************</span>
<a name="l00165"></a>00165 <span class="comment"> Implementation methods</span>
<a name="l00166"></a>00166 <span class="comment"> *************************************************************************/</span>
<a name="l00177"></a><a class="code" href="classCEGUI_1_1ProgressBar.html#af7b5d8a9f84a3edb6d2ae5b29630757b">00177</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> testClassName_impl(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& class_name)<span class="keyword"> const</span>
<a name="l00178"></a>00178 <span class="keyword"> </span>{
<a name="l00179"></a>00179 <span class="keywordflow">if</span> (class_name==<span class="stringliteral">"ProgressBar"</span>) <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00180"></a>00180 <span class="keywordflow">return</span> <a class="code" href="classCEGUI_1_1Window.html#a2b58cf00b4790c9cb08acfc18d5d3b0b" title="Return whether this window was inherited from the given class name at some point in the inheritance h...">Window::testClassName_impl</a>(class_name);
<a name="l00181"></a>00181 }
<a name="l00182"></a>00182
<a name="l00183"></a>00183
<a name="l00184"></a>00184 <span class="comment">/*************************************************************************</span>
<a name="l00185"></a>00185 <span class="comment"> Event handlers for progress bar specific events</span>
<a name="l00186"></a>00186 <span class="comment"> *************************************************************************/</span>
<a name="l00191"></a>00191 <span class="keyword">virtual</span> <span class="keywordtype">void</span> onProgressChanged(<a class="code" href="classCEGUI_1_1WindowEventArgs.html" title="EventArgs based class that is used for objects passed to handlers triggered for events concerning som...">WindowEventArgs</a>& e);
<a name="l00192"></a>00192
<a name="l00193"></a>00193
<a name="l00198"></a>00198 <span class="keyword">virtual</span> <span class="keywordtype">void</span> onProgressDone(<a class="code" href="classCEGUI_1_1WindowEventArgs.html" title="EventArgs based class that is used for objects passed to handlers triggered for events concerning som...">WindowEventArgs</a>& e);
<a name="l00199"></a>00199
<a name="l00200"></a>00200
<a name="l00201"></a>00201 <span class="comment">/*************************************************************************</span>
<a name="l00202"></a>00202 <span class="comment"> Implementation Data</span>
<a name="l00203"></a>00203 <span class="comment"> *************************************************************************/</span>
<a name="l00204"></a><a class="code" href="classCEGUI_1_1ProgressBar.html#aab42ffc13ea83b337ca2b387c4091e35">00204</a> <span class="keywordtype">float</span> <a class="code" href="classCEGUI_1_1ProgressBar.html#aab42ffc13ea83b337ca2b387c4091e35" title="current progress (from 0.0f to 1.0f)">d_progress</a>;
<a name="l00205"></a><a class="code" href="classCEGUI_1_1ProgressBar.html#a7a3d60decbf719053900816441800110">00205</a> <span class="keywordtype">float</span> <a class="code" href="classCEGUI_1_1ProgressBar.html#a7a3d60decbf719053900816441800110" title="amount to 'step' progress by on a call to step()">d_step</a>;
<a name="l00206"></a>00206
<a name="l00207"></a>00207
<a name="l00208"></a>00208 <span class="keyword">private</span>:
<a name="l00209"></a>00209 <span class="comment">/*************************************************************************</span>
<a name="l00210"></a>00210 <span class="comment"> Static Properties for this class</span>
<a name="l00211"></a>00211 <span class="comment"> *************************************************************************/</span>
<a name="l00212"></a>00212 <span class="keyword">static</span> <a class="code" href="classCEGUI_1_1ProgressBarProperties_1_1CurrentProgress.html" title="Property to access the current progress of the progress bar.">ProgressBarProperties::CurrentProgress</a> d_currentProgressProperty;
<a name="l00213"></a>00213 <span class="keyword">static</span> <a class="code" href="classCEGUI_1_1ProgressBarProperties_1_1StepSize.html" title="Property to access the step size setting for the progress bar.">ProgressBarProperties::StepSize</a> d_stepSizeProperty;
<a name="l00214"></a>00214
<a name="l00215"></a>00215
<a name="l00216"></a>00216 <span class="comment">/*************************************************************************</span>
<a name="l00217"></a>00217 <span class="comment"> Private methods</span>
<a name="l00218"></a>00218 <span class="comment"> *************************************************************************/</span>
<a name="l00219"></a>00219 <span class="keywordtype">void</span> addProgressBarProperties(<span class="keywordtype">void</span>);
<a name="l00220"></a>00220 };
<a name="l00221"></a>00221
<a name="l00222"></a>00222 } <span class="comment">// End of CEGUI namespace section</span>
<a name="l00223"></a>00223
<a name="l00224"></a>00224 <span class="preprocessor">#if defined(_MSC_VER)</span>
<a name="l00225"></a>00225 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(pop)</span>
<a name="l00226"></a>00226 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00227"></a>00227 <span class="preprocessor"></span>
<a name="l00228"></a>00228 <span class="preprocessor">#endif // end of guard _CEGUIProgressBar_h_</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:39 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>
|
