<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /tmp/qt-4.2.1-harald-1161357942206/qt-x11-opensource-src-4.2.1/doc/src/qiterator.qdoc -->
<head>
<title>Qt 4.2: QListIterator Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://www.trolltech.com/products/qt"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></a></td>
<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="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"><a href="http://www.trolltech.com"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></a></td></tr></table><h1 align="center">QListIterator Class Reference<br /><sup><sup>[<a href="qtcore.html">QtCore</a> module]</sup></sup></h1>
<p>The QListIterator class provides a Java-style const iterator for <a href="qlist.html">QList</a> and <a href="qqueue.html">QQueue</a>. <a href="#details">More...</a></p>
<pre> #include <QListIterator></pre><ul>
<li><a href="qlistiterator-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"/><b><a href="qlistiterator.html#QListIterator">QListIterator</a></b> ( const QList<T> & <i>list</i> )</li>
<li><div class="fn"/>bool <b><a href="qlistiterator.html#findNext">findNext</a></b> ( const T & <i>value</i> )</li>
<li><div class="fn"/>bool <b><a href="qlistiterator.html#findPrevious">findPrevious</a></b> ( const T & <i>value</i> )</li>
<li><div class="fn"/>bool <b><a href="qlistiterator.html#hasNext">hasNext</a></b> () const</li>
<li><div class="fn"/>bool <b><a href="qlistiterator.html#hasPrevious">hasPrevious</a></b> () const</li>
<li><div class="fn"/>const T & <b><a href="qlistiterator.html#next">next</a></b> ()</li>
<li><div class="fn"/>const T & <b><a href="qlistiterator.html#peekNext">peekNext</a></b> () const</li>
<li><div class="fn"/>const T & <b><a href="qlistiterator.html#peekPrevious">peekPrevious</a></b> () const</li>
<li><div class="fn"/>const T & <b><a href="qlistiterator.html#previous">previous</a></b> ()</li>
<li><div class="fn"/>void <b><a href="qlistiterator.html#toBack">toBack</a></b> ()</li>
<li><div class="fn"/>void <b><a href="qlistiterator.html#toFront">toFront</a></b> ()</li>
<li><div class="fn"/>QListIterator & <b><a href="qlistiterator.html#operator-eq">operator=</a></b> ( const QList<T> & <i>list</i> )</li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QListIterator class provides a Java-style const iterator for <a href="qlist.html">QList</a> and <a href="qqueue.html">QQueue</a>.</p>
<p><a href="qlist.html">QList</a> has both <a href="containers.html#java-style-iterators">Java-style iterators</a> and <a href="containers.html#stl-style-iterators">STL-style iterators</a>. The Java-style iterators are more high-level and easier to use than the STL-style iterators; on the other hand, they are slightly less efficient.</p>
<p>An alternative to using iterators is to use index positions. Most <a href="qlist.html">QList</a> member functions take an index as their first parameter, making it possible to access, modify, and remove items without using iterators.</p>
<p>QListIterator<T> allows you to iterate over a <a href="qlist.html">QList</a><T> (or a <a href="qqueue.html">QQueue</a><T>). If you want to modify the list as you iterate over it, use <a href="qmutablelistiterator.html">QMutableListIterator</a><T> instead.</p>
<p>The QListIterator constructor takes a <a href="qlist.html">QList</a> as argument. After construction, the iterator is located at the very beginning of the list (before the first item). Here's how to iterate over all the elements sequentially:</p>
<pre> QList<float> list;
...
QListIterator<float> i(list);
while (i.hasNext())
qDebug() << i.next();</pre>
<p>The <a href="qlistiterator.html#next">next</a>() function returns the next item in the list and advances the iterator. Unlike STL-style iterators, Java-style iterators point <i>between</i> items rather than directly <i>at</i> items. The first call to <a href="qlistiterator.html#next">next</a>() advances the iterator to the position between the first and second item, and returns the first item; the second call to <a href="qlistiterator.html#next">next</a>() advances the iterator to the position between the second and third item, and returns the second item; and so on.</p>
<p align="center"><img src="images/javaiterators1.png" /></p><p>Here's how to iterate over the elements in reverse order:</p>
<pre> QListIterator<float> i(list);
i.toBack();
while (i.hasPrevious())
qDebug() << i.previous();</pre>
<p>If you want to find all occurrences of a particular value, use <a href="qlistiterator.html#findNext">findNext</a>() or <a href="qlistiterator.html#findPrevious">findPrevious</a>() in a loop.</p>
<p>Multiple iterators can be used on the same list. If the list is modified while a QListIterator is active, the QListIterator will continue iterating over the original list, ignoring the modified copy.</p>
<p>See also <a href="qmutablelistiterator.html">QMutableListIterator</a> and <a href="qlist-const-iterator.html">QList::const_iterator</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QListIterator"></a>QListIterator::QListIterator ( const <a href="qlist.html">QList</a><T> & <i>list</i> )</h3>
<p>Constructs an iterator for traversing <i>list</i>. The iterator is set to be at the front of the list (before the first item).</p>
<p>See also <a href="qlistiterator.html#operator-eq">operator=</a>().</p>
<h3 class="fn"><a name="findNext"></a>bool QListIterator::findNext ( const T & <i>value</i> )</h3>
<p>Searches for <i>value</i> starting from the current iterator position forward. Returns true if <i>value</i> is found; otherwise returns false.</p>
<p>After the call, if <i>value</i> was found, the iterator is positioned just after the matching item; otherwise, the iterator is positioned at the back of the container.</p>
<p>See also <a href="qlistiterator.html#findPrevious">findPrevious</a>().</p>
<h3 class="fn"><a name="findPrevious"></a>bool QListIterator::findPrevious ( const T & <i>value</i> )</h3>
<p>Searches for <i>value</i> starting from the current iterator position backward. Returns true if <i>value</i> is found; otherwise returns false.</p>
<p>After the call, if <i>value</i> was found, the iterator is positioned just before the matching item; otherwise, the iterator is positioned at the front of the container.</p>
<p>See also <a href="qlistiterator.html#findNext">findNext</a>().</p>
<h3 class="fn"><a name="hasNext"></a>bool QListIterator::hasNext () const</h3>
<p>Returns true if there is at least one item ahead of the iterator, i.e. the iterator is <i>not</i> at the back of the container; otherwise returns false.</p>
<p>See also <a href="qlistiterator.html#hasPrevious">hasPrevious</a>() and <a href="qlistiterator.html#next">next</a>().</p>
<h3 class="fn"><a name="hasPrevious"></a>bool QListIterator::hasPrevious () const</h3>
<p>Returns true if there is at least one item behind the iterator, i.e. the iterator is <i>not</i> at the front of the container; otherwise returns false.</p>
<p>See also <a href="qlistiterator.html#hasNext">hasNext</a>() and <a href="qlistiterator.html#previous">previous</a>().</p>
<h3 class="fn"><a name="next"></a>const T & QListIterator::next ()</h3>
<p>Returns the next item and advances the iterator by one position.</p>
<p>Calling this function on an iterator located at the back of the container leads to undefined results.</p>
<p>See also <a href="qlistiterator.html#hasNext">hasNext</a>(), <a href="qlistiterator.html#peekNext">peekNext</a>(), and <a href="qlistiterator.html#previous">previous</a>().</p>
<h3 class="fn"><a name="peekNext"></a>const T & QListIterator::peekNext () const</h3>
<p>Returns the next item without moving the iterator.</p>
<p>Calling this function on an iterator located at the back of the container leads to undefined results.</p>
<p>See also <a href="qlistiterator.html#hasNext">hasNext</a>(), <a href="qlistiterator.html#next">next</a>(), and <a href="qlistiterator.html#peekPrevious">peekPrevious</a>().</p>
<h3 class="fn"><a name="peekPrevious"></a>const T & QListIterator::peekPrevious () const</h3>
<p>Returns the previous item without moving the iterator.</p>
<p>Calling this function on an iterator located at the front of the container leads to undefined results.</p>
<p>See also <a href="qlistiterator.html#hasPrevious">hasPrevious</a>(), <a href="qlistiterator.html#previous">previous</a>(), and <a href="qlistiterator.html#peekNext">peekNext</a>().</p>
<h3 class="fn"><a name="previous"></a>const T & QListIterator::previous ()</h3>
<p>Returns the previous item and moves the iterator back by one position.</p>
<p>Calling this function on an iterator located at the front of the container leads to undefined results.</p>
<p>See also <a href="qlistiterator.html#hasPrevious">hasPrevious</a>(), <a href="qlistiterator.html#peekPrevious">peekPrevious</a>(), and <a href="qlistiterator.html#next">next</a>().</p>
<h3 class="fn"><a name="toBack"></a>void QListIterator::toBack ()</h3>
<p>Moves the iterator to the back of the container (after the last item).</p>
<p>See also <a href="qlistiterator.html#toFront">toFront</a>() and <a href="qlistiterator.html#previous">previous</a>().</p>
<h3 class="fn"><a name="toFront"></a>void QListIterator::toFront ()</h3>
<p>Moves the iterator to the front of the container (before the first item).</p>
<p>See also <a href="qlistiterator.html#toBack">toBack</a>() and <a href="qlistiterator.html#next">next</a>().</p>
<h3 class="fn"><a name="operator-eq"></a>QListIterator & QListIterator::operator= ( const <a href="qlist.html">QList</a><T> & <i>list</i> )</h3>
<p>Makes the iterator operate on <i>list</i>. The iterator is set to be at the front of the list (before the first item).</p>
<p>See also <a href="qlistiterator.html#toFront">toFront</a>() and <a href="qlistiterator.html#toBack">toBack</a>().</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright © 2006 <a href="trolltech.html">Trolltech</a></td>
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt 4.2.1</div></td>
</tr></table></div></address></body>
</html>
