<?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/q3asciidict.qdoc -->
<head>
<title>Qt 4.2: Q3AsciiDictIterator 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">Q3AsciiDictIterator Class Reference<br /><sup><sup>[<a href="qt3support.html">Qt3Support</a> module]</sup></sup></h1>
<p>The Q3AsciiDictIterator class provides an iterator for <a href="q3asciidict.html">Q3AsciiDict</a> collections. <a href="#details">More...</a></p>
<pre> #include <Q3AsciiDictIterator></pre><p><b>This class is part of the Qt 3 support library.</b> It is provided to keep old source code working. We strongly advise against using it in new code. See <a href="porting4.html">Porting to Qt 4</a> for more information.</p>
<ul>
<li><a href="q3asciidictiterator-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="q3asciidictiterator.html#Q3AsciiDictIterator">Q3AsciiDictIterator</a></b> ( const Q3AsciiDict<type> & <i>dict</i> )</li>
<li><div class="fn"/><b><a href="q3asciidictiterator.html#dtor.Q3AsciiDictIterator">~Q3AsciiDictIterator</a></b> ()</li>
<li><div class="fn"/>uint <b><a href="q3asciidictiterator.html#count">count</a></b> () const</li>
<li><div class="fn"/>type * <b><a href="q3asciidictiterator.html#current">current</a></b> () const</li>
<li><div class="fn"/>const char * <b><a href="q3asciidictiterator.html#currentKey">currentKey</a></b> () const</li>
<li><div class="fn"/>bool <b><a href="q3asciidictiterator.html#isEmpty">isEmpty</a></b> () const</li>
<li><div class="fn"/>type * <b><a href="q3asciidictiterator.html#toFirst">toFirst</a></b> ()</li>
<li><div class="fn"/><b><a href="q3asciidictiterator.html#operator-type--2a">operator type *</a></b> () const</li>
<li><div class="fn"/>type * <b><a href="q3asciidictiterator.html#operator-28-29">operator()</a></b> ()</li>
<li><div class="fn"/>type * <b><a href="q3asciidictiterator.html#operator-2b-2b">operator++</a></b> ()</li>
<li><div class="fn"/>type * <b><a href="q3asciidictiterator.html#operator-2b-eq">operator+=</a></b> ( uint <i>jump</i> )</li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The Q3AsciiDictIterator class provides an iterator for <a href="q3asciidict.html">Q3AsciiDict</a> collections.</p>
<p>Q3AsciiDictIterator is implemented as a template class. Define a template instance Q3AsciiDictIterator<X> to create a dictionary iterator that operates on <a href="q3asciidict.html">Q3AsciiDict</a><X> (dictionary of X*).</p>
<p>Example:</p>
<pre> Q3AsciiDict<QLineEdit> fields;
fields.insert( "forename", new QLineEdit( this ) );
fields.insert( "surname", new QLineEdit( this ) );
fields.insert( "age", new QLineEdit( this ) );
fields["forename"]->setText( "Homer" );
fields["surname"]->setText( "Simpson" );
fields["age"]->setText( "45" );
Q3AsciiDictIterator<QLineEdit> it( fields );
for( ; it.current(); ++it )
cout << it.currentKey() << ": " << it.current()->text() << endl;
cout << endl;
<span class="comment"> // Output (random order):</span>
<span class="comment"> // age: 45</span>
<span class="comment"> // surname: Simpson</span>
<span class="comment"> // forename: Homer</span></pre>
<p>In the example we insert some line edits into a dictionary, then iterate over the dictionary printing the strings associated with those line edits.</p>
<p>Note that the traversal order is arbitrary; you are not guaranteed any particular order.</p>
<p>Multiple iterators may independently traverse the same dictionary. A <a href="q3asciidict.html">Q3AsciiDict</a> knows about all the iterators that are operating on the dictionary. When an item is removed from the dictionary, <a href="q3asciidict.html">Q3AsciiDict</a> updates all the iterators that are referring to the removed item to point to the next item in the (arbitrary) traversal order.</p>
<p>See also <a href="q3asciidict.html">Q3AsciiDict</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="Q3AsciiDictIterator"></a>Q3AsciiDictIterator::Q3AsciiDictIterator ( const <a href="q3asciidict.html">Q3AsciiDict</a><type> & <i>dict</i> )</h3>
<p>Constructs an iterator for <i>dict</i>. The current iterator item is set to point on the first item in the <i>dict</i>.</p>
<h3 class="fn"><a name="dtor.Q3AsciiDictIterator"></a>Q3AsciiDictIterator::~Q3AsciiDictIterator ()</h3>
<p>Destroys the iterator.</p>
<h3 class="fn"><a name="count"></a><a href="qtglobal.html#uint-typedef">uint</a> Q3AsciiDictIterator::count () const</h3>
<p>Returns the number of items in the dictionary this iterator operates over.</p>
<p>See also <a href="q3asciidictiterator.html#isEmpty">isEmpty</a>().</p>
<h3 class="fn"><a name="current"></a>type * Q3AsciiDictIterator::current () const</h3>
<p>Returns a pointer to the current iterator item.</p>
<h3 class="fn"><a name="currentKey"></a>const char * Q3AsciiDictIterator::currentKey () const</h3>
<p>Returns a pointer to the key for the current iterator item.</p>
<h3 class="fn"><a name="isEmpty"></a>bool Q3AsciiDictIterator::isEmpty () const</h3>
<p>Returns TRUE if the dictionary is empty, i.e. <a href="q3asciidictiterator.html#count">count</a>() == 0, otherwise returns FALSE.</p>
<p>See also <a href="q3asciidictiterator.html#count">count</a>().</p>
<h3 class="fn"><a name="toFirst"></a>type * Q3AsciiDictIterator::toFirst ()</h3>
<p>Sets the current iterator item to point to the first item in the dictionary and returns a pointer to the item. If the dictionary is empty it sets the current item to 0 and returns 0.</p>
<h3 class="fn"><a name="operator-type--2a"></a>Q3AsciiDictIterator::operator type * () const</h3>
<p>Cast operator. Returns a pointer to the current iterator item. Same as <a href="q3asciidictiterator.html#current">current</a>().</p>
<h3 class="fn"><a name="operator-28-29"></a>type * Q3AsciiDictIterator::operator() ()</h3>
<p>Makes the succeeding item current and returns the original current item.</p>
<p>If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned.</p>
<h3 class="fn"><a name="operator-2b-2b"></a>type * Q3AsciiDictIterator::operator++ ()</h3>
<p>Prefix ++ makes the succeeding item current and returns the new current item.</p>
<p>If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned.</p>
<h3 class="fn"><a name="operator-2b-eq"></a>type * Q3AsciiDictIterator::operator+= ( <a href="qtglobal.html#uint-typedef">uint</a> <i>jump</i> )</h3>
<p>Sets the current item to the item <i>jump</i> positions after the current item, and returns a pointer to that item.</p>
<p>If that item is beyond the last item or if the dictionary is empty, it sets the current item to 0 and returns 0.</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>
