summaryrefslogtreecommitdiffstats
path: root/doc/html/qmapconstiterator.html
blob: 15f7566adcd0603137448d048b104ffd0bf647af (plain)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/doc/qmap.doc:773 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QMapConstIterator Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QMapConstIterator Class Reference</h1>

<p>The QMapConstIterator class provides an iterator for QMap.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qmap-h.html">qmap.h</a>&gt;</tt>
<p><a href="qmapconstiterator-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn>typedef std::bidirectional_iterator_tag&nbsp;<a href="#iterator_category"><b>iterator_category</b></a></li>
<li class=fn>typedef T&nbsp;<a href="#value_type"><b>value_type</b></a></li>
<li class=fn>typedef const&nbsp;T&nbsp;*&nbsp;<a href="#pointer"><b>pointer</b></a></li>
<li class=fn>typedef const&nbsp;T&nbsp;&amp;&nbsp;<a href="#reference"><b>reference</b></a></li>
<li class=fn><a href="#QMapConstIterator"><b>QMapConstIterator</b></a> ()</li>
<li class=fn><a href="#QMapConstIterator-2"><b>QMapConstIterator</b></a> ( QMapNode&lt;K,&nbsp;T&gt;&nbsp;*&nbsp;p )</li>
<li class=fn><a href="#QMapConstIterator-3"><b>QMapConstIterator</b></a> ( const&nbsp;QMapConstIterator&lt;K,&nbsp;T&gt;&nbsp;&amp;&nbsp;it )</li>
<li class=fn><a href="#QMapConstIterator-4"><b>QMapConstIterator</b></a> ( const&nbsp;QMapIterator&lt;K,&nbsp;T&gt;&nbsp;&amp;&nbsp;it )</li>
<li class=fn>bool <a href="#operator-eq-eq"><b>operator==</b></a> ( const&nbsp;QMapConstIterator&lt;K,&nbsp;T&gt;&nbsp;&amp;&nbsp;it ) const</li>
<li class=fn>bool <a href="#operator!-eq"><b>operator!=</b></a> ( const&nbsp;QMapConstIterator&lt;K,&nbsp;T&gt;&nbsp;&amp;&nbsp;it ) const</li>
<li class=fn>const T &amp; <a href="#operator*"><b>operator*</b></a> () const</li>
<li class=fn>const K &amp; <a href="#key"><b>key</b></a> () const</li>
<li class=fn>const T &amp; <a href="#data"><b>data</b></a> () const</li>
<li class=fn>QMapConstIterator&lt;K, T&gt; &amp; <a href="#operator++"><b>operator++</b></a> ()</li>
<li class=fn>QMapConstIterator&lt;K, T&gt; <a href="#operator++-2"><b>operator++</b></a> ( int )</li>
<li class=fn>QMapConstIterator&lt;K, T&gt; &amp; <a href="#operator--"><b>operator--</b></a> ()</li>
<li class=fn>QMapConstIterator&lt;K, T&gt; <a href="#operator---2"><b>operator--</b></a> ( int )</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The QMapConstIterator class provides an iterator for <a href="qmap.html">QMap</a>.
<p> 

<p> In contrast to <a href="qmapiterator.html">QMapIterator</a>, this class is used to iterate over a
const map. It does not allow you to modify the values of the map
because this would break the const semantics.
<p> For more information on QMap iterators, see <a href="qmapiterator.html">QMapIterator</a> and
the <a href="qmap.html#qmap-eg">QMap example</a>.
<p> <p>See also <a href="qmap.html">QMap</a>, <a href="qmapiterator.html">QMapIterator</a>, <a href="qtl.html">Qt Template Library Classes</a>, and <a href="tools.html">Non-GUI Classes</a>.

<hr><h2>Member Type Documentation</h2>
<h3 class=fn><a name="iterator_category"></a>QMapConstIterator::iterator_category</h3> 
The type of iterator category, <tt>std::bidirectional_iterator_tag</tt>. 
<h3 class=fn><a name="pointer"></a>QMapConstIterator::pointer</h3> 
Const pointer to value_type. 
<h3 class=fn><a name="reference"></a>QMapConstIterator::reference</h3> 
Const reference to value_type. 
<h3 class=fn><a name="value_type"></a>QMapConstIterator::value_type</h3> 
The type of const value. 
<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QMapConstIterator"></a>QMapConstIterator::QMapConstIterator ()
</h3>

<p> Constructs an uninitialized iterator.

<h3 class=fn><a name="QMapConstIterator-2"></a>QMapConstIterator::QMapConstIterator ( QMapNode&lt;K,&nbsp;T&gt;&nbsp;*&nbsp;p )
</h3>

<p> Constructs an iterator starting at node <em>p</em>.

<h3 class=fn><a name="QMapConstIterator-3"></a>QMapConstIterator::QMapConstIterator ( const&nbsp;<a href="qmapconstiterator.html">QMapConstIterator</a>&lt;K,&nbsp;T&gt;&nbsp;&amp;&nbsp;it )
</h3>

<p> Constructs a copy of the iterator, <em>it</em>.

<h3 class=fn><a name="QMapConstIterator-4"></a>QMapConstIterator::QMapConstIterator ( const&nbsp;<a href="qmapiterator.html">QMapIterator</a>&lt;K,&nbsp;T&gt;&nbsp;&amp;&nbsp;it )
</h3>

<p> Constructs a copy of the iterator, <em>it</em>.

<h3 class=fn>const T &amp; <a name="data"></a>QMapConstIterator::data () const
</h3>

<p> Returns a const reference to the current item's data.

<h3 class=fn>const K &amp; <a name="key"></a>QMapConstIterator::key () const
</h3>

<p> Returns a const reference to the current item's key.

<h3 class=fn>bool <a name="operator!-eq"></a>QMapConstIterator::operator!= ( const&nbsp;<a href="qmapconstiterator.html">QMapConstIterator</a>&lt;K,&nbsp;T&gt;&nbsp;&amp;&nbsp;it ) const
</h3>

<p> Compares the iterator to the <em>it</em> iterator and returns FALSE if
they point to the same item; otherwise returns TRUE.

<h3 class=fn>const T &amp; <a name="operator*"></a>QMapConstIterator::operator* () const
</h3>

<p> Dereference operator. Returns a const reference to the current
item's data. The same as <a href="#data">data</a>().

<h3 class=fn><a href="qmapconstiterator.html">QMapConstIterator</a>&lt;K,&nbsp;T&gt;&nbsp;&amp; <a name="operator++"></a>QMapConstIterator::operator++ ()
</h3>

<p> Prefix ++ makes the succeeding item current and returns an
iterator pointing to the new current item. The iterator cannot
check whether it reached the end of the map. Incrementing the
iterator returned by end() causes undefined results.

<h3 class=fn><a href="qmapconstiterator.html">QMapConstIterator</a>&lt;K,&nbsp;T&gt; <a name="operator++-2"></a>QMapConstIterator::operator++ ( int )
</h3>

<p> This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Postfix ++ makes the succeeding item current and returns an
iterator pointing to the new current item. The iterator cannot
check whether it reached the end of the map. Incrementing the
iterator returned by end() causes undefined results.

<h3 class=fn><a href="qmapconstiterator.html">QMapConstIterator</a>&lt;K,&nbsp;T&gt;&nbsp;&amp; <a name="operator--"></a>QMapConstIterator::operator-- ()
</h3>

<p> Prefix -- makes the previous item current and returns an iterator
pointing to the new current item. The iterator cannot check
whether it reached the beginning of the map. Decrementing the
iterator returned by begin() causes undefined results.

<h3 class=fn><a href="qmapconstiterator.html">QMapConstIterator</a>&lt;K,&nbsp;T&gt; <a name="operator---2"></a>QMapConstIterator::operator-- ( int )
</h3>

<p> This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Postfix -- makes the previous item current and returns an iterator
pointing to the new current item. The iterator cannot check
whether it reached the beginning of the map. Decrementing the
iterator returned by begin() causes undefined results.

<h3 class=fn>bool <a name="operator-eq-eq"></a>QMapConstIterator::operator== ( const&nbsp;<a href="qmapconstiterator.html">QMapConstIterator</a>&lt;K,&nbsp;T&gt;&nbsp;&amp;&nbsp;it ) const
</h3>

<p> Compares the iterator to the <em>it</em> iterator and returns TRUE if
they point to the same item; otherwise returns FALSE.

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>