~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/html/qlinkedlist-iterator.html

  • Committer: Bazaar Package Importer
  • Author(s): Alessandro Ghersi
  • Date: 2009-11-02 18:30:08 UTC
  • mfrom: (1.2.2 upstream)
  • mto: (15.2.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 88.
  • Revision ID: james.westby@ubuntu.com-20091102183008-b6a4gcs128mvfb3m
Tags: upstream-4.6.0~beta1
ImportĀ upstreamĀ versionĀ 4.6.0~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<!DOCTYPE html
3
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
4
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
 
<!-- /fasttmp/mkdist-qt-4.5.2-1245473805/qt-x11-opensource-src-4.5.2/src/corelib/tools/qlinkedlist.cpp -->
 
5
<!-- qlinkedlist.cpp -->
6
6
<head>
7
 
  <title>Qt 4.5: iterator Class Reference</title>
 
7
  <title>Qt 4.6: iterator Class Reference</title>
8
8
  <link href="classic.css" rel="stylesheet" type="text/css" />
9
9
</head>
10
10
<body>
 
11
<a name="//apple_ref/cpp/cl/QLinkedList/iterator" />
11
12
<table border="0" cellpadding="0" cellspacing="0" width="100%">
12
13
<tr>
13
 
<td align="left" valign="top" width="32"><a href="http://qtsoftware.com/products/qt"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
14
 
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="namespaces.html"><font color="#004faf">All&nbsp;Namespaces</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="modules.html"><font color="#004faf">Modules</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
15
 
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">iterator Class Reference<br /><span class="small-subtitle">(QLinkedList::iterator)<br />[<a href="qtcore.html">QtCore</a> module]</span>
 
14
<td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
 
15
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">All&nbsp;Functions</font></a>&nbsp;&middot; <a href="overviews.html"><font color="#004faf">Overviews</font></a></td><td class="searchBar" align="right" valign="center"><form action="http://www.google.com/cse" id="cse-search-box"><div><input type="hidden" name="cx" value="000136343326384750312:dhbxnqlakyu" /><input type="hidden" name="ie" value="UTF-8" /><input type="text" name="q" size="31" /><input type="submit" name="sa" value="Search" /></div></form></td>
 
16
</tr></table><h1 class="title">iterator Class Reference<br /><span class="small-subtitle">(QLinkedList::iterator)<br />[<a href="qtcore.html">QtCore</a> module]</span>
16
17
</h1>
17
18
<p>The QLinkedList::iterator class provides an STL-style non-const iterator for <a href="qlinkedlist.html">QLinkedList</a>. <a href="#details">More...</a></p>
18
19
<pre> #include &lt;<a href="qlinkedlist.html">QLinkedList</a>&gt;</pre><p>Inherited by <a href="q3valuelistiterator.html" class="compat">Q3ValueListIterator</a>.</p>
19
20
<ul>
20
21
<li><a href="qlinkedlist-iterator-members.html">List of all members, including inherited members</a></li>
21
22
</ul>
 
23
<hr />
22
24
<a name="public-functions"></a>
23
 
<h3>Public Functions</h3>
24
 
<ul>
25
 
<li><div class="fn"></div><b><a href="qlinkedlist-iterator.html#iterator">iterator</a></b> ()</li>
26
 
<li><div class="fn"></div><b><a href="qlinkedlist-iterator.html#iterator-3">iterator</a></b> ( const iterator &amp; <i>other</i> )</li>
27
 
<li><div class="fn"></div>bool <b><a href="qlinkedlist-iterator.html#operator-not-eq">operator!=</a></b> ( const iterator &amp; <i>other</i> ) const</li>
28
 
<li><div class="fn"></div>bool <b><a href="qlinkedlist-iterator.html#operator-not-eq-2">operator!=</a></b> ( const const_iterator &amp; <i>other</i> ) const</li>
29
 
<li><div class="fn"></div>T &amp; <b><a href="qlinkedlist-iterator.html#operator-2a">operator*</a></b> () const</li>
30
 
<li><div class="fn"></div>iterator <b><a href="qlinkedlist-iterator.html#operator-2b">operator+</a></b> ( int <i>j</i> ) const</li>
31
 
<li><div class="fn"></div>iterator &amp; <b><a href="qlinkedlist-iterator.html#operator-2b-2b">operator++</a></b> ()</li>
32
 
<li><div class="fn"></div>iterator <b><a href="qlinkedlist-iterator.html#operator-2b-2b-2">operator++</a></b> ( int )</li>
33
 
<li><div class="fn"></div>iterator &amp; <b><a href="qlinkedlist-iterator.html#operator-2b-eq">operator+=</a></b> ( int <i>j</i> )</li>
34
 
<li><div class="fn"></div>iterator <b><a href="qlinkedlist-iterator.html#operator-">operator-</a></b> ( int <i>j</i> ) const</li>
35
 
<li><div class="fn"></div>iterator &amp; <b><a href="qlinkedlist-iterator.html#operator--">operator--</a></b> ()</li>
36
 
<li><div class="fn"></div>iterator <b><a href="qlinkedlist-iterator.html#operator---2">operator--</a></b> ( int )</li>
37
 
<li><div class="fn"></div>iterator &amp; <b><a href="qlinkedlist-iterator.html#operator--eq">operator-=</a></b> ( int <i>j</i> )</li>
38
 
<li><div class="fn"></div>T * <b><a href="qlinkedlist-iterator.html#operator--gt">operator-&gt;</a></b> () const</li>
39
 
<li><div class="fn"></div>iterator &amp; <b><a href="qlinkedlist-iterator.html#operator-eq">operator=</a></b> ( const iterator &amp; <i>other</i> )</li>
40
 
<li><div class="fn"></div>bool <b><a href="qlinkedlist-iterator.html#operator-eq-eq">operator==</a></b> ( const iterator &amp; <i>other</i> ) const</li>
41
 
<li><div class="fn"></div>bool <b><a href="qlinkedlist-iterator.html#operator-eq-eq-2">operator==</a></b> ( const const_iterator &amp; <i>other</i> ) const</li>
42
 
</ul>
 
25
<h2>Public Functions</h2>
 
26
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
27
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#iterator">iterator</a></b> ()</td></tr>
 
28
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#iterator-3">iterator</a></b> ( const iterator &amp; <i>other</i> )</td></tr>
 
29
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#operator-not-eq">operator!=</a></b> ( const iterator &amp; <i>other</i> ) const</td></tr>
 
30
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#operator-not-eq-2">operator!=</a></b> ( const const_iterator &amp; <i>other</i> ) const</td></tr>
 
31
<tr><td class="memItemLeft" align="right" valign="top">T &amp; </td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#operator-2a">operator*</a></b> () const</td></tr>
 
32
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#operator-2b">operator+</a></b> ( int <i>j</i> ) const</td></tr>
 
33
<tr><td class="memItemLeft" align="right" valign="top">iterator &amp; </td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#operator-2b-2b">operator++</a></b> ()</td></tr>
 
34
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#operator-2b-2b-2">operator++</a></b> ( int )</td></tr>
 
35
<tr><td class="memItemLeft" align="right" valign="top">iterator &amp; </td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#operator-2b-eq">operator+=</a></b> ( int <i>j</i> )</td></tr>
 
36
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#operator-">operator-</a></b> ( int <i>j</i> ) const</td></tr>
 
37
<tr><td class="memItemLeft" align="right" valign="top">iterator &amp; </td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#operator--">operator--</a></b> ()</td></tr>
 
38
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#operator---2">operator--</a></b> ( int )</td></tr>
 
39
<tr><td class="memItemLeft" align="right" valign="top">iterator &amp; </td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#operator--eq">operator-=</a></b> ( int <i>j</i> )</td></tr>
 
40
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#operator--gt">operator-&gt;</a></b> () const</td></tr>
 
41
<tr><td class="memItemLeft" align="right" valign="top">iterator &amp; </td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#operator-eq">operator=</a></b> ( const iterator &amp; <i>other</i> )</td></tr>
 
42
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#operator-eq-eq">operator==</a></b> ( const iterator &amp; <i>other</i> ) const</td></tr>
 
43
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qlinkedlist-iterator.html#operator-eq-eq-2">operator==</a></b> ( const const_iterator &amp; <i>other</i> ) const</td></tr>
 
44
</table>
43
45
<a name="details"></a>
44
46
<hr />
45
47
<h2>Detailed Description</h2>
93
95
     ++i;
94
96
 }</pre>
95
97
<p>However, this will potentially crash in <tt>++i</tt>, because <tt>i</tt> is a dangling iterator after the call to <a href="qlinkedlist.html#erase">erase</a>().</p>
96
 
<p>Multiple iterators can be used on the same list. If you add items to the list, existing iterators will remain valid. If you remove items from the list, iterators that point to the removed items will become dangling iterators. However, because of how <a href="shared.html#implicit-sharing">implicit sharing</a> works, you must not take a copy of a container while iterators are active on that container.</p>
 
98
<p>Multiple iterators can be used on the same list. If you add items to the list, existing iterators will remain valid. If you remove items from the list, iterators that point to the removed items will become dangling iterators. However, because of how <a href="implicit-sharing.html">implicit sharing</a> works, you must not take a copy of a container while iterators are active on that container.</p>
97
99
<p>See also <a href="qlinkedlist-const-iterator.html">QLinkedList::const_iterator</a> and <a href="qmutablelinkedlistiterator.html">QMutableLinkedListIterator</a>.</p>
98
100
<hr />
99
101
<h2>Member Function Documentation</h2>
 
102
<a name="//apple_ref/cpp/instm/QLinkedList::iterator/iterator" />
100
103
<h3 class="fn"><a name="iterator"></a>iterator::iterator ()</h3>
101
104
<p>Constructs an uninitialized iterator.</p>
102
105
<p>Functions like operator*() and operator++() should not be called on an uninitialized iterator. Use operator=() to assign a value to it before using it.</p>
103
106
<p>See also <a href="qlinkedlist.html#begin">QLinkedList::begin</a>() and <a href="qlinkedlist.html#end">QLinkedList::end</a>().</p>
104
107
<h3 class="fn"><a name="iterator-3"></a>iterator::iterator ( const iterator &amp; <i>other</i> )</h3>
105
108
<p>Constructs a copy of <i>other</i>.</p>
 
109
<a name="//apple_ref/cpp/instm/QLinkedList::iterator/operator!=" />
106
110
<h3 class="fn"><a name="operator-not-eq"></a>bool iterator::operator!= ( const iterator &amp; <i>other</i> ) const</h3>
107
111
<p>Returns true if <i>other</i> points to a different item than this iterator; otherwise returns false.</p>
108
112
<p>See also <a href="qlinkedlist-iterator.html#operator-eq-eq">operator==</a>().</p>
109
113
<h3 class="fn"><a name="operator-not-eq-2"></a>bool iterator::operator!= ( const <a href="qlinkedlist-const-iterator.html">const_iterator</a> &amp; <i>other</i> ) const</h3>
110
114
<p>Returns true if <i>other</i> points to a different item than this iterator; otherwise returns false.</p>
111
115
<p>See also <a href="qlinkedlist-iterator.html#operator-eq-eq">operator==</a>().</p>
 
116
<a name="//apple_ref/cpp/instm/QLinkedList::iterator/operator*" />
112
117
<h3 class="fn"><a name="operator-2a"></a>T &amp; iterator::operator* () const</h3>
113
118
<p>Returns a modifiable reference to the current item.</p>
114
119
<p>You can change the value of an item by using operator*() on the left side of an assignment, for example:</p>
115
120
<pre> if (*it == &quot;Hello&quot;)
116
121
     *it = &quot;Bonjour&quot;;</pre>
117
122
<p>See also <a href="qlinkedlist-iterator.html#operator--gt">operator-&gt;</a>().</p>
 
123
<a name="//apple_ref/cpp/instm/QLinkedList::iterator/operator+" />
118
124
<h3 class="fn"><a name="operator-2b"></a>iterator iterator::operator+ ( int <i>j</i> ) const</h3>
119
125
<p>Returns an iterator to the item at <i>j</i> positions forward from this iterator. (If <i>j</i> is negative, the iterator goes backward.)</p>
120
126
<p>This operation can be slow for large <i>j</i> values.</p>
121
127
<p>See also <a href="qlinkedlist-iterator.html#operator-">operator-</a>().</p>
 
128
<a name="//apple_ref/cpp/instm/QLinkedList::iterator/operator++" />
122
129
<h3 class="fn"><a name="operator-2b-2b"></a>iterator &amp; iterator::operator++ ()</h3>
123
130
<p>The prefix ++ operator (<tt>++it</tt>) advances the iterator to the next item in the list and returns an iterator to the new current item.</p>
124
131
<p>Calling this function on <a href="qlinkedlist.html#end">QLinkedList::end</a>() leads to undefined results.</p>
126
133
<h3 class="fn"><a name="operator-2b-2b-2"></a>iterator iterator::operator++ ( int )</h3>
127
134
<p>This is an overloaded function.</p>
128
135
<p>The postfix ++ operator (<tt>it++</tt>) advances the iterator to the next item in the list and returns an iterator to the previously current item.</p>
 
136
<a name="//apple_ref/cpp/instm/QLinkedList::iterator/operator+=" />
129
137
<h3 class="fn"><a name="operator-2b-eq"></a>iterator &amp; iterator::operator+= ( int <i>j</i> )</h3>
130
138
<p>Advances the iterator by <i>j</i> items. (If <i>j</i> is negative, the iterator goes backward.)</p>
131
139
<p>See also <a href="qlinkedlist-iterator.html#operator--eq">operator-=</a>() and <a href="qlinkedlist-iterator.html#operator-2b">operator+</a>().</p>
 
140
<a name="//apple_ref/cpp/instm/QLinkedList::iterator/operator-" />
132
141
<h3 class="fn"><a name="operator-"></a>iterator iterator::operator- ( int <i>j</i> ) const</h3>
133
142
<p>Returns an iterator to the item at <i>j</i> positions backward from this iterator. (If <i>j</i> is negative, the iterator goes forward.)</p>
134
143
<p>This operation can be slow for large <i>j</i> values.</p>
135
144
<p>See also <a href="qlinkedlist-iterator.html#operator-2b">operator+</a>().</p>
 
145
<a name="//apple_ref/cpp/instm/QLinkedList::iterator/operator--" />
136
146
<h3 class="fn"><a name="operator--"></a>iterator &amp; iterator::operator-- ()</h3>
137
147
<p>The prefix -- operator (<tt>--it</tt>) makes the preceding item current and returns an iterator to the new current item.</p>
138
148
<p>Calling this function on <a href="qlinkedlist.html#begin">QLinkedList::begin</a>() leads to undefined results.</p>
140
150
<h3 class="fn"><a name="operator---2"></a>iterator iterator::operator-- ( int )</h3>
141
151
<p>This is an overloaded function.</p>
142
152
<p>The postfix -- operator (<tt>it--</tt>) makes the preceding item current and returns an iterator to the previously current item.</p>
 
153
<a name="//apple_ref/cpp/instm/QLinkedList::iterator/operator-=" />
143
154
<h3 class="fn"><a name="operator--eq"></a>iterator &amp; iterator::operator-= ( int <i>j</i> )</h3>
144
155
<p>Makes the iterator go back by <i>j</i> items. (If <i>j</i> is negative, the iterator goes forward.)</p>
145
156
<p>See also <a href="qlinkedlist-iterator.html#operator-2b-eq">operator+=</a>() and <a href="qlinkedlist-iterator.html#operator-">operator-</a>().</p>
 
157
<a name="//apple_ref/cpp/instm/QLinkedList::iterator/operator->" />
146
158
<h3 class="fn"><a name="operator--gt"></a>T * iterator::operator-&gt; () const</h3>
147
159
<p>Returns a pointer to the current item.</p>
148
160
<p>See also <a href="qlinkedlist-iterator.html#operator-2a">operator*</a>().</p>
 
161
<a name="//apple_ref/cpp/instm/QLinkedList::iterator/operator=" />
149
162
<h3 class="fn"><a name="operator-eq"></a>iterator &amp; iterator::operator= ( const iterator &amp; <i>other</i> )</h3>
150
163
<p>Assigns <i>other</i> to this iterator.</p>
 
164
<a name="//apple_ref/cpp/instm/QLinkedList::iterator/operator==" />
151
165
<h3 class="fn"><a name="operator-eq-eq"></a>bool iterator::operator== ( const iterator &amp; <i>other</i> ) const</h3>
152
166
<p>Returns true if <i>other</i> points to the same item as this iterator; otherwise returns false.</p>
153
167
<p>See also <a href="qlinkedlist-iterator.html#operator-not-eq">operator!=</a>().</p>
156
170
<p>See also <a href="qlinkedlist-iterator.html#operator-not-eq">operator!=</a>().</p>
157
171
<p /><address><hr /><div align="center">
158
172
<table width="100%" cellspacing="0" border="0"><tr class="address">
159
 
<td width="30%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
160
 
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
161
 
<td width="30%" align="right"><div align="right">Qt 4.5.2</div></td>
162
 
</tr></table></div></address></body>
 
173
<td width="40%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
 
174
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
175
<td width="40%" align="right"><div align="right">Qt 4.6.0</div></td>
 
176
<script type="text/javascript" src="http://www.google.com/jsapi"></script><script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script><script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en"></script><script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script></tr></table></div></address></body>
163
177
</html>