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

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="annotated.html"><font color="#004faf">Annotated</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>

<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QLinkedList::iterator Class Reference</h1>

<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>

<pre>#include <QLinkedList></pre><p>Part of the <a href="qtcore.html">QtCore</a> module.</p>

<p>Inherited by <a href="q3valuelistiterator.html">Q3ValueListIterator</a>.</p>

<ul>

<li><a href="qlinkedlist-iterator-members.html">List of all members, including inherited members</a></li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="qlinkedlist-iterator.html#iterator">iterator</a></b> ()</li>

<li><div class="fn"/><b><a href="qlinkedlist-iterator.html#iterator-3">iterator</a></b> ( const iterator & <i>other</i> )</li>

<li><div class="fn"/>bool <b><a href="qlinkedlist-iterator.html#operator-not-eq">operator!=</a></b> ( const iterator & <i>other</i> ) const</li>

<li><div class="fn"/>bool <b><a href="qlinkedlist-iterator.html#operator-not-eq-2">operator!=</a></b> ( const const_iterator & <i>other</i> ) const</li>

<li><div class="fn"/>T & <b><a href="qlinkedlist-iterator.html#operator-2a">operator*</a></b> () const</li>

<li><div class="fn"/>iterator <b><a href="qlinkedlist-iterator.html#operator-2b">operator+</a></b> ( int <i>j</i> ) const</li>

<li><div class="fn"/>iterator & <b><a href="qlinkedlist-iterator.html#operator-2b-2b">operator++</a></b> ()</li>

<li><div class="fn"/>iterator <b><a href="qlinkedlist-iterator.html#operator-2b-2b-2">operator++</a></b> ( int )</li>

<li><div class="fn"/>iterator & <b><a href="qlinkedlist-iterator.html#operator-2b-eq">operator+=</a></b> ( int <i>j</i> )</li>

<li><div class="fn"/>iterator <b><a href="qlinkedlist-iterator.html#operator-">operator-</a></b> ( int <i>j</i> ) const</li>

<li><div class="fn"/>iterator & <b><a href="qlinkedlist-iterator.html#operator--">operator--</a></b> ()</li>

<li><div class="fn"/>iterator <b><a href="qlinkedlist-iterator.html#operator---2">operator--</a></b> ( int )</li>

<li><div class="fn"/>iterator & <b><a href="qlinkedlist-iterator.html#operator--eq">operator-=</a></b> ( int <i>j</i> )</li>

<li><div class="fn"/>T * <b><a href="qlinkedlist-iterator.html#operator--gt">operator-></a></b> () const</li>

<li><div class="fn"/>iterator & <b><a href="qlinkedlist-iterator.html#operator-eq">operator=</a></b> ( const iterator & <i>other</i> )</li>

<li><div class="fn"/>bool <b><a href="qlinkedlist-iterator.html#operator-eq-eq">operator==</a></b> ( const iterator & <i>other</i> ) const</li>

<li><div class="fn"/>bool <b><a href="qlinkedlist-iterator.html#operator-eq-eq-2">operator==</a></b> ( const const_iterator & <i>other</i> ) const</li>

</ul>

<hr />

<h2>Detailed Description</h2>

<p>The QLinkedList::iterator class provides an STL-style non-const iterator for <a href="qlinkedlist.html">QLinkedList</a>.</p>

<p><a href="qlinkedlist.html">QLinkedList</a> features both <a href="containers.html#stl-style-iterators">STL-style iterators</a> and <a href="containers.html#java-style-iterators">Java-style iterators</a>. The STL-style iterators are more low-level and more cumbersome to use; on the other hand, they are slightly faster and, for developers who already know STL, have the advantage of familiarity.</p>

<p><a href="qlinkedlist.html">QLinkedList</a><T>::iterator allows you to iterate over a <a href="qlinkedlist.html">QLinkedList</a><T> and to modify the list item associated with the iterator. If you want to iterate over a const <a href="qlinkedlist.html">QLinkedList</a>, use <a href="qlinkedlist-const-iterator.html">QLinkedList::const_iterator</a> instead. It is generally good practice to use <a href="qlinkedlist-const-iterator.html">QLinkedList::const_iterator</a> on a non-const <a href="qlinkedlist.html">QLinkedList</a> as well, unless you need to change the <a href="qlinkedlist.html">QLinkedList</a> through the iterator. Const iterators are slightly faster, and can improve code readability.</p>

<p>The default QLinkedList::iterator constructor creates an uninitialized iterator. You must initialize it using a function like <a href="qlinkedlist.html#begin">QLinkedList::begin</a>(), <a href="qlinkedlist.html#end">QLinkedList::end</a>(), or <a href="qlinkedlist.html#insert">QLinkedList::insert</a>() before you can start iterating. Here's a typical loop that prints all the items stored in a list:</p>

<pre>  QLinkedList<QString> list;

list.append("January");

list.append("February");

...

list.append("December");

QLinkedList<QString>::iterator i;

for (i = list.begin(); i != list.end(); ++i)

cout << *i << endl;</pre>

<p>STL-style iterators can be used as arguments to <a href="qtalgorithms.html">generic algorithms</a>. For example, here's how to find an item in the list using the <a href="qtalgorithms.html#qFind">qFind</a>() algorithm:</p>

<pre>  QLinkedList<QString> list;

...

QLinkedList<QString>::iterator it = qFind(list.begin(),

list.end(), "Joel");

if (it != list.end())

cout << "Found Joel" << endl;</pre>

<p>Let's see a few examples of things we can do with a QLinkedList::iterator that we cannot do with a <a href="qlinkedlist-const-iterator.html">QLinkedList::const_iterator</a>. Here's an example that increments every value stored in a <a href="qlinkedlist.html">QLinkedList</a><int> by 2:</p>

<pre>  QLinkedList<int>::iterator i;

for (i = list.begin(); i != list.end(); ++i)

*i += 2;</pre>

<p>Here's an example that removes all the items that start with an underscore character in a <a href="qlinkedlist.html">QLinkedList</a><<a href="qstring.html">QString</a>>:</p>

<pre>  QLinkedList<QString> list;

...

QLinkedList<QString>::iterator i = list.begin();

while (i != list.end()) {

if ((*i).startsWith("_"))

i = list.erase(i);

else

++i;

}</pre>

<p>The call to <a href="qlinkedlist.html#erase">QLinkedList::erase</a>() removes the item pointed to by the iterator from the list, and returns an iterator to the next item. Here's another way of removing an item while iterating:</p>

<pre>  QLinkedList<QString>::iterator i = list.begin();

while (i != list.end()) {

QLinkedList<QString>::iterator previous = i;

++i;

if ((*previous).startsWith("_"))

list.erase(previous);

}</pre>

<p>It might be tempting to write code like this:</p>

<pre>  // WRONG

while (i != list.end()) {

if ((*i).startsWith("_"))

list.erase(i);

++i;

}</pre>

100

<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>

101

<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.</p>

102

<p>See also <a href="qlinkedlist-const-iterator.html">QLinkedList::const_iterator</a> and <a href="qmutablelinkedlistiterator.html">QMutableLinkedListIterator</a>.</p>

103

<hr />

104

<h2>Member Function Documentation</h2>

105

<h3 class="fn"><a name="iterator"></a>iterator::iterator ()</h3>

106

<p>Constructs an uninitialized iterator.</p>

107

<p>Functions like operator*() and operator++() should not be called on an uninitialized iterartor. Use operator=() to assign a value to it before using it.</p>

108

<p>See also <a href="qlinkedlist.html#begin">QLinkedList::begin</a>() and <a href="qlinkedlist.html#end">QLinkedList::end</a>().</p>

109

<h3 class="fn"><a name="iterator-3"></a>iterator::iterator ( const iterator & <i>other</i> )</h3>

110

<p>Constructs a copy of <i>other</i>.</p>

111

<h3 class="fn"><a name="operator-not-eq"></a>bool iterator::operator!= ( const iterator & <i>other</i> ) const</h3>

112

<p>Returns true if <i>other</i> points to a different item than this iterator; otherwise returns false.</p>

113

<p>See also <a href="qlinkedlist-iterator.html#operator-eq-eq">operator==</a>().</p>

114

<h3 class="fn"><a name="operator-not-eq-2"></a>bool iterator::operator!= ( const <a href="qlinkedlist-const-iterator.html">const_iterator</a> & <i>other</i> ) const</h3>

115

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

116

<p>Returns true if <i>other</i> points to a different item than this iterator; otherwise returns false.</p>

117

<p>See also <a href="qlinkedlist-iterator.html#operator-eq-eq">operator==</a>().</p>

118

<h3 class="fn"><a name="operator-2a"></a>T & iterator::operator* () const</h3>

119

<p>Returns a modifiable reference to the current item.</p>

120

<p>You can change the value of an item by using operator*() on the left side of an assignment, for example:</p>

121

<pre>  if (*it == "Hello")

122

*it = "Bonjour";</pre>

123

<p>See also <a href="qlinkedlist-iterator.html#operator--gt">operator-></a>().</p>

124

<h3 class="fn"><a name="operator-2b"></a>iterator iterator::operator+ ( int <i>j</i> ) const</h3>

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>

126

<p>This operation can be slow for large <i>j</i> values.</p>

127

<p>See also <a href="qlinkedlist-iterator.html#operator-">operator-</a>().</p>

128

<h3 class="fn"><a name="operator-2b-2b"></a>iterator & iterator::operator++ ()</h3>

129

<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>

130

<p>Calling this function on <a href="qlinkedlist.html#end">QLinkedList::end</a>() leads to undefined results.</p>

131

<p>See also <a href="qlinkedlist-iterator.html#operator--">operator--</a>().</p>

132

<h3 class="fn"><a name="operator-2b-2b-2"></a>iterator iterator::operator++ ( int )</h3>

133

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

134

<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>

135

<h3 class="fn"><a name="operator-2b-eq"></a>iterator & iterator::operator+= ( int <i>j</i> )</h3>

136

<p>Advances the iterator by <i>j</i> items. (If <i>j</i> is negative, the iterator goes backward.)</p>

137

<p>See also <a href="qlinkedlist-iterator.html#operator--eq">operator-=</a>() and <a href="qlinkedlist-iterator.html#operator-2b">operator+</a>().</p>

138

<h3 class="fn"><a name="operator-"></a>iterator iterator::operator- ( int <i>j</i> ) const</h3>

139

<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>

140

<p>This operation can be slow for large <i>j</i> values.</p>

141

<p>See also <a href="qlinkedlist-iterator.html#operator-2b">operator+</a>().</p>

142

<h3 class="fn"><a name="operator--"></a>iterator & iterator::operator-- ()</h3>

143

<p>The prefix -- operator (<tt>--it</tt>) makes the preceding item current and returns an iterator to the new current item.</p>

144

<p>Calling this function on <a href="qlinkedlist.html#begin">QLinkedList::begin</a>() leads to undefined results.</p>

145

<p>See also <a href="qlinkedlist-iterator.html#operator-2b-2b">operator++</a>().</p>

146

<h3 class="fn"><a name="operator---2"></a>iterator iterator::operator-- ( int )</h3>

147

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

148

<p>The postfix -- operator (<tt>it--</tt>) makes the preceding item current and returns an iterator to the previously current item.</p>

149

<h3 class="fn"><a name="operator--eq"></a>iterator & iterator::operator-= ( int <i>j</i> )</h3>

150

<p>Makes the iterator go back by <i>j</i> items. (If <i>j</i> is negative, the iterator goes forward.)</p>

151

<p>See also <a href="qlinkedlist-iterator.html#operator-2b-eq">operator+=</a>() and <a href="qlinkedlist-iterator.html#operator-">operator-</a>().</p>

152

<h3 class="fn"><a name="operator--gt"></a>T * iterator::operator-> () const</h3>

153

<p>Returns a pointer to the current item.</p>

154

<p>See also <a href="qlinkedlist-iterator.html#operator-2a">operator*</a>().</p>

155

<h3 class="fn"><a name="operator-eq"></a>iterator & iterator::operator= ( const iterator & <i>other</i> )</h3>

156

<p>Assigns <i>other</i> to this iterator.</p>

157

<h3 class="fn"><a name="operator-eq-eq"></a>bool iterator::operator== ( const iterator & <i>other</i> ) const</h3>

158

<p>Returns true if <i>other</i> points to the same item as this iterator; otherwise returns false.</p>

159

<p>See also <a href="qlinkedlist-iterator.html#operator-not-eq">operator!=</a>().</p>

160

<h3 class="fn"><a name="operator-eq-eq-2"></a>bool iterator::operator== ( const <a href="qlinkedlist-const-iterator.html">const_iterator</a> & <i>other</i> ) const</h3>

161

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

162

<p>Returns true if <i>other</i> points to the same item as this iterator; otherwise returns false.</p>

163

<p>See also <a href="qlinkedlist-iterator.html#operator-not-eq">operator!=</a>().</p>

164

165

166

167

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

168

169

</tr></table></div></address></body>

170

</html>

Older »