source: trunk/doc/html/qmapconstiterator.html

Last change on this file was 190, checked in by rudi, 14 years ago

reference documentation added
File size: 8.8 KB
RevLine 
[190]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/doc/qmap.doc:773 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QMapConstIterator Class</title>
7<style type="text/css"><!--
8fn { margin-left: 1cm; text-indent: -1cm; }
9a:link { color: #004faf; text-decoration: none }
10a:visited { color: #672967; text-decoration: none }
11body { background: #ffffff; color: black; }
12--></style>
13</head>
14<body>
15
16<table border="0" cellpadding="0" cellspacing="0" width="100%">
17<tr bgcolor="#E5E5E5">
18<td valign=center>
19 <a href="index.html">
20<font color="#004faf">Home</font></a>
21 | <a href="classes.html">
22<font color="#004faf">All&nbsp;Classes</font></a>
23 | <a href="mainclasses.html">
24<font color="#004faf">Main&nbsp;Classes</font></a>
25 | <a href="annotated.html">
26<font color="#004faf">Annotated</font></a>
27 | <a href="groups.html">
28<font color="#004faf">Grouped&nbsp;Classes</font></a>
29 | <a href="functions.html">
30<font color="#004faf">Functions</font></a>
31</td>
32<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>
33
34<p>The QMapConstIterator class provides an iterator for QMap.
35<a href="#details">More...</a>
36<p><tt>#include &lt;<a href="qmap-h.html">qmap.h</a>&gt;</tt>
37<p><a href="qmapconstiterator-members.html">List of all member functions.</a>
38<h2>Public Members</h2>
39<ul>
40<li class=fn>typedef std::bidirectional_iterator_tag&nbsp;<a href="#iterator_category"><b>iterator_category</b></a></li>
41<li class=fn>typedef T&nbsp;<a href="#value_type"><b>value_type</b></a></li>
42<li class=fn>typedef const&nbsp;T&nbsp;*&nbsp;<a href="#pointer"><b>pointer</b></a></li>
43<li class=fn>typedef const&nbsp;T&nbsp;&amp;&nbsp;<a href="#reference"><b>reference</b></a></li>
44<li class=fn><a href="#QMapConstIterator"><b>QMapConstIterator</b></a> ()</li>
45<li class=fn><a href="#QMapConstIterator-2"><b>QMapConstIterator</b></a> ( QMapNode&lt;K,&nbsp;T&gt;&nbsp;*&nbsp;p )</li>
46<li class=fn><a href="#QMapConstIterator-3"><b>QMapConstIterator</b></a> ( const&nbsp;QMapConstIterator&lt;K,&nbsp;T&gt;&nbsp;&amp;&nbsp;it )</li>
47<li class=fn><a href="#QMapConstIterator-4"><b>QMapConstIterator</b></a> ( const&nbsp;QMapIterator&lt;K,&nbsp;T&gt;&nbsp;&amp;&nbsp;it )</li>
48<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>
49<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>
50<li class=fn>const T &amp; <a href="#operator*"><b>operator*</b></a> () const</li>
51<li class=fn>const K &amp; <a href="#key"><b>key</b></a> () const</li>
52<li class=fn>const T &amp; <a href="#data"><b>data</b></a> () const</li>
53<li class=fn>QMapConstIterator&lt;K, T&gt; &amp; <a href="#operator++"><b>operator++</b></a> ()</li>
54<li class=fn>QMapConstIterator&lt;K, T&gt; <a href="#operator++-2"><b>operator++</b></a> ( int )</li>
55<li class=fn>QMapConstIterator&lt;K, T&gt; &amp; <a href="#operator--"><b>operator--</b></a> ()</li>
56<li class=fn>QMapConstIterator&lt;K, T&gt; <a href="#operator---2"><b>operator--</b></a> ( int )</li>
57</ul>
58<hr><a name="details"></a><h2>Detailed Description</h2>
59
60
61The QMapConstIterator class provides an iterator for <a href="qmap.html">QMap</a>.
62<p>
63
64<p> In contrast to <a href="qmapiterator.html">QMapIterator</a>, this class is used to iterate over a
65const map. It does not allow you to modify the values of the map
66because this would break the const semantics.
67<p> For more information on QMap iterators, see <a href="qmapiterator.html">QMapIterator</a> and
68the <a href="qmap.html#qmap-eg">QMap example</a>.
69<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>.
70
71<hr><h2>Member Type Documentation</h2>
72<h3 class=fn><a name="iterator_category"></a>QMapConstIterator::iterator_category</h3>
73The type of iterator category, <tt>std::bidirectional_iterator_tag</tt>.
74<h3 class=fn><a name="pointer"></a>QMapConstIterator::pointer</h3>
75Const pointer to value_type.
76<h3 class=fn><a name="reference"></a>QMapConstIterator::reference</h3>
77Const reference to value_type.
78<h3 class=fn><a name="value_type"></a>QMapConstIterator::value_type</h3>
79The type of const value.
80<hr><h2>Member Function Documentation</h2>
81<h3 class=fn><a name="QMapConstIterator"></a>QMapConstIterator::QMapConstIterator ()
82</h3>
83
84<p> Constructs an uninitialized iterator.
85
86<h3 class=fn><a name="QMapConstIterator-2"></a>QMapConstIterator::QMapConstIterator ( QMapNode&lt;K,&nbsp;T&gt;&nbsp;*&nbsp;p )
87</h3>
88
89<p> Constructs an iterator starting at node <em>p</em>.
90
91<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 )
92</h3>
93
94<p> Constructs a copy of the iterator, <em>it</em>.
95
96<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 )
97</h3>
98
99<p> Constructs a copy of the iterator, <em>it</em>.
100
101<h3 class=fn>const T &amp; <a name="data"></a>QMapConstIterator::data () const
102</h3>
103
104<p> Returns a const reference to the current item's data.
105
106<h3 class=fn>const K &amp; <a name="key"></a>QMapConstIterator::key () const
107</h3>
108
109<p> Returns a const reference to the current item's key.
110
111<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
112</h3>
113
114<p> Compares the iterator to the <em>it</em> iterator and returns FALSE if
115they point to the same item; otherwise returns TRUE.
116
117<h3 class=fn>const T &amp; <a name="operator*"></a>QMapConstIterator::operator* () const
118</h3>
119
120<p> Dereference operator. Returns a const reference to the current
121item's data. The same as <a href="#data">data</a>().
122
123<h3 class=fn><a href="qmapconstiterator.html">QMapConstIterator</a>&lt;K,&nbsp;T&gt;&nbsp;&amp; <a name="operator++"></a>QMapConstIterator::operator++ ()
124</h3>
125
126<p> Prefix ++ makes the succeeding item current and returns an
127iterator pointing to the new current item. The iterator cannot
128check whether it reached the end of the map. Incrementing the
129iterator returned by end() causes undefined results.
130
131<h3 class=fn><a href="qmapconstiterator.html">QMapConstIterator</a>&lt;K,&nbsp;T&gt; <a name="operator++-2"></a>QMapConstIterator::operator++ ( int )
132</h3>
133
134<p> This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
135<p> Postfix ++ makes the succeeding item current and returns an
136iterator pointing to the new current item. The iterator cannot
137check whether it reached the end of the map. Incrementing the
138iterator returned by end() causes undefined results.
139
140<h3 class=fn><a href="qmapconstiterator.html">QMapConstIterator</a>&lt;K,&nbsp;T&gt;&nbsp;&amp; <a name="operator--"></a>QMapConstIterator::operator-- ()
141</h3>
142
143<p> Prefix -- makes the previous item current and returns an iterator
144pointing to the new current item. The iterator cannot check
145whether it reached the beginning of the map. Decrementing the
146iterator returned by begin() causes undefined results.
147
148<h3 class=fn><a href="qmapconstiterator.html">QMapConstIterator</a>&lt;K,&nbsp;T&gt; <a name="operator---2"></a>QMapConstIterator::operator-- ( int )
149</h3>
150
151<p> This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
152<p> Postfix -- makes the previous item current and returns an iterator
153pointing to the new current item. The iterator cannot check
154whether it reached the beginning of the map. Decrementing the
155iterator returned by begin() causes undefined results.
156
157<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
158</h3>
159
160<p> Compares the iterator to the <em>it</em> iterator and returns TRUE if
161they point to the same item; otherwise returns FALSE.
162
163<!-- eof -->
164<hr><p>
165This file is part of the <a href="index.html">Qt toolkit</a>.
166Copyright &copy; 1995-2007
167<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
168<table width=100% cellspacing=0 border=0><tr>
169<td>Copyright &copy; 2007
170<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
171<td align=right><div align=right>Qt 3.3.8</div>
172</table></div></address></body>
173</html>
Note: See TracBrowser for help on using the repository browser.