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
|
<!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::ConstBaseIterator< T > Class Template 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_1ConstBaseIterator.html">ConstBaseIterator</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::ConstBaseIterator< T > Class Template Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::ConstBaseIterator" -->
<p>Base class constant iterator used to offer iteration over various collections within the system.
<a href="classCEGUI_1_1ConstBaseIterator.html#details">More...</a></p>
<p><a href="classCEGUI_1_1ConstBaseIterator-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adaed0b4c80ab5b9d3bd1b7fe41f9721a"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::mapped_type" ref="adaed0b4c80ab5b9d3bd1b7fe41f9721a" args="" -->
typedef T::mapped_type </td><td class="memItemRight" valign="bottom"><b>mapped_type</b></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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#a1bac981829f0297cf4cc2aaebeff61ec">ConstBaseIterator</a> (typename T::const_iterator start_iter, typename T::const_iterator end_iter)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html" title="Base class constant iterator used to offer iteration over various collections within the system...">ConstBaseIterator</a> constructor. <a href="#a1bac981829f0297cf4cc2aaebeff61ec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a09ebee01bf877018fc6b79eb6238153e"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::~ConstBaseIterator" ref="a09ebee01bf877018fc6b79eb6238153e" args="(void)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#a09ebee01bf877018fc6b79eb6238153e">~ConstBaseIterator</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html" title="Base class constant iterator used to offer iteration over various collections within the system...">ConstBaseIterator</a> destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbd4e176984e5c03d9376fffae91fb93"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::ConstBaseIterator" ref="acbd4e176984e5c03d9376fffae91fb93" args="(const ConstBaseIterator< T > &org)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#acbd4e176984e5c03d9376fffae91fb93">ConstBaseIterator</a> (const <a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a>< T > &org)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html" title="Base class constant iterator used to offer iteration over various collections within the system...">ConstBaseIterator</a> copy constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec66369c1949fd84e3eb1adedef919df"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::operator=" ref="aec66369c1949fd84e3eb1adedef919df" args="(const ConstBaseIterator< T > &rhs)" -->
<a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#aec66369c1949fd84e3eb1adedef919df">operator=</a> (const <a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a>< T > &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html" title="Base class constant iterator used to offer iteration over various collections within the system...">ConstBaseIterator</a> assignment operator. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac5252eba57ab719cb6d100c3e1790504"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::getCurrentKey" ref="ac5252eba57ab719cb6d100c3e1790504" args="(void) const " -->
T::key_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#ac5252eba57ab719cb6d100c3e1790504">getCurrentKey</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the key for the item at the current iterator position. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8867315bd652dc664db7c90cdcd6056f"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::getCurrentValue" ref="a8867315bd652dc664db7c90cdcd6056f" args="(void) const " -->
mapped_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#a8867315bd652dc664db7c90cdcd6056f">getCurrentValue</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value for the item at the current iterator position. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44a0532d22e5e629969a055cee4be467"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::isAtEnd" ref="a44a0532d22e5e629969a055cee4be467" args="(void) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#a44a0532d22e5e629969a055cee4be467">isAtEnd</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether the current iterator position is at the end of the iterators range. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8417a804623d0d537b89d6a46ef08c51"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::isAtStart" ref="a8417a804623d0d537b89d6a46ef08c51" args="(void) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#a8417a804623d0d537b89d6a46ef08c51">isAtStart</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether the current iterator position is at the start of the iterators range. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#acd70539df6196261c1d4d80435cfe745">operator++</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Increase the iterator position (prefix increment). <a href="#acd70539df6196261c1d4d80435cfe745"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a>< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#ac4f4f4151df76f48e1f72cc365c03d92">operator++</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Increase the iterator position (postfix increment). <a href="#ac4f4f4151df76f48e1f72cc365c03d92"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#a70e64c3289210da1e0ddff08b3226555">operator--</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrease the iterator position (prefix decrement). <a href="#a70e64c3289210da1e0ddff08b3226555"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a>< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#a7460749ec52c53cc8baa7b5b06a726db">operator--</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrease the iterator position (postfix decrement). <a href="#a7460749ec52c53cc8baa7b5b06a726db"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad05474615593895376c8b5bd71fd74e2"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::operator==" ref="ad05474615593895376c8b5bd71fd74e2" args="(const ConstBaseIterator< T > &rhs) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#ad05474615593895376c8b5bd71fd74e2">operator==</a> (const <a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a>< T > &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compares two iterators. Return true if the current position of both iterators are equivalent. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69b9dbbdb8fc8edc69063822e7a48dd4"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::operator!=" ref="a69b9dbbdb8fc8edc69063822e7a48dd4" args="(const ConstBaseIterator< T > &rhs) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#a69b9dbbdb8fc8edc69063822e7a48dd4">operator!=</a> (const <a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a>< T > &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compares two iterators. Return true if the current position of the iterators are different. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa8e68eb289691ea558c627df4bbf59f2"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::operator*" ref="aa8e68eb289691ea558c627df4bbf59f2" args="() const " -->
mapped_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#aa8e68eb289691ea558c627df4bbf59f2">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value for the current iterator position. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ef0d1e4ab64e72d189fe91d1b2cb18f"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::toStart" ref="a0ef0d1e4ab64e72d189fe91d1b2cb18f" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#a0ef0d1e4ab64e72d189fe91d1b2cb18f">toStart</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the iterator current position to the start position. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2702eac9903ece2fe27688134253a41"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::toEnd" ref="ab2702eac9903ece2fe27688134253a41" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html#ab2702eac9903ece2fe27688134253a41">toEnd</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the iterator current position to the end position. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class T><br/>
class CEGUI::ConstBaseIterator< T ></h3>
<p>Base class constant iterator used to offer iteration over various collections within the system. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1bac981829f0297cf4cc2aaebeff61ec"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::ConstBaseIterator" ref="a1bac981829f0297cf4cc2aaebeff61ec" args="(typename T::const_iterator start_iter, typename T::const_iterator end_iter)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html">CEGUI::ConstBaseIterator</a>< T >::<a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a> </td>
<td>(</td>
<td class="paramtype">typename T::const_iterator </td>
<td class="paramname"><em>start_iter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename T::const_iterator </td>
<td class="paramname"><em>end_iter</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1ConstBaseIterator.html" title="Base class constant iterator used to offer iteration over various collections within the system...">ConstBaseIterator</a> constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">start_iter</td><td>'real' iterator that will be the start of the range to be iterated over by this iterator.</td></tr>
<tr><td class="paramname">end_iter</td><td>'real' iterator that will be the end of the range to be iterated over by this iterator. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acd70539df6196261c1d4d80435cfe745"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::operator++" ref="acd70539df6196261c1d4d80435cfe745" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a><T>& <a class="el" href="classCEGUI_1_1ConstBaseIterator.html">CEGUI::ConstBaseIterator</a>< T >::operator++ </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Increase the iterator position (prefix increment). </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The iterator is checked, and this call will always succeed, so do not rely on some exception to exit a loop. </dd></dl>
</div>
</div>
<a class="anchor" id="ac4f4f4151df76f48e1f72cc365c03d92"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::operator++" ref="ac4f4f4151df76f48e1f72cc365c03d92" args="(int)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a><T> <a class="el" href="classCEGUI_1_1ConstBaseIterator.html">CEGUI::ConstBaseIterator</a>< T >::operator++ </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Increase the iterator position (postfix increment). </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The iterator is checked, and this call will always succeed, so do not rely on some exception to exit a loop. </dd></dl>
</div>
</div>
<a class="anchor" id="a70e64c3289210da1e0ddff08b3226555"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::operator--" ref="a70e64c3289210da1e0ddff08b3226555" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a><T>& <a class="el" href="classCEGUI_1_1ConstBaseIterator.html">CEGUI::ConstBaseIterator</a>< T >::operator-- </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decrease the iterator position (prefix decrement). </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The iterator is checked, and this call will always succeed, so do not rely on some exception to exit a loop. </dd></dl>
</div>
</div>
<a class="anchor" id="a7460749ec52c53cc8baa7b5b06a726db"></a><!-- doxytag: member="CEGUI::ConstBaseIterator::operator--" ref="a7460749ec52c53cc8baa7b5b06a726db" args="(int)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a><T> <a class="el" href="classCEGUI_1_1ConstBaseIterator.html">CEGUI::ConstBaseIterator</a>< T >::operator-- </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decrease the iterator position (postfix decrement). </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The iterator is checked, and this call will always succeed, so do not rely on some exception to exit a loop. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 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>
|
