~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">Q3DictIterator Class Reference</h1>

<p>The Q3DictIterator class provides an iterator for <a href="q3dict.html">Q3Dict</a> collections. <a href="#details">More...</a></p>

<pre>#include <Q3DictIterator></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 the <a href="porting4.html">Porting Guide</a> for more information.</p>

<p>Part of the <a href="qt3support.html">Qt3Support</a> module.</p>

<ul>

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

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="q3dictiterator.html#Q3DictIterator">Q3DictIterator</a></b> ( const Q3Dict<type> & <i>dict</i> )</li>

<li><div class="fn"/><b><a href="q3dictiterator.html#dtor.Q3DictIterator">~Q3DictIterator</a></b> ()</li>

<li><div class="fn"/>uint <b><a href="q3dictiterator.html#count">count</a></b> () const</li>

<li><div class="fn"/>type * <b><a href="q3dictiterator.html#current">current</a></b> () const</li>

<li><div class="fn"/>QString <b><a href="q3dictiterator.html#currentKey">currentKey</a></b> () const</li>

<li><div class="fn"/>bool <b><a href="q3dictiterator.html#isEmpty">isEmpty</a></b> () const</li>

<li><div class="fn"/>type * <b><a href="q3dictiterator.html#toFirst">toFirst</a></b> ()</li>

<li><div class="fn"/><b><a href="q3dictiterator.html#operator-type--2a">operator type *</a></b> () const</li>

<li><div class="fn"/>type * <b><a href="q3dictiterator.html#operator-28-29">operator()</a></b> ()</li>

<li><div class="fn"/>type * <b><a href="q3dictiterator.html#operator-2b-2b">operator++</a></b> ()</li>

</ul>

<hr />

<h2>Detailed Description</h2>

<p>The Q3DictIterator class provides an iterator for <a href="q3dict.html">Q3Dict</a> collections.</p>

<p>Q3DictIterator is implemented as a template class. Define a template instance Q3DictIterator<X> to create a dictionary iterator that operates on <a href="q3dict.html">Q3Dict</a><X> (dictionary of X*).</p>

<p>The traversal order is arbitrary; when we speak of the "first", "last" and "next" item we are talking in terms of this arbitrary order.</p>

<p>Multiple iterators may independently traverse the same dictionary. A <a href="q3dict.html">Q3Dict</a> knows about all the iterators that are operating on the dictionary. When an item is removed from the dictionary, <a href="q3dict.html">Q3Dict</a> updates all iterators that are referring to the removed item to point to the next item in the (arbitrary) traversal order.</p>

<p>Example:</p>

<pre>  Q3Dict<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" );

Q3DictIterator<QLineEdit> it( fields );

for( ; it.current(); ++it )

cout << it.currentKey() << ": " << it.current()->text() << endl;

cout << endl;

// Output (random order):

// age: 45

// surname: Simpson

// forename: Homer</pre>

<p>In the example we insert some pointers to line edits into a dictionary, then iterate over the dictionary printing the strings associated with the line edits.</p>

<hr />

<h2>Member Function Documentation</h2>

<h3 class="fn"><a name="Q3DictIterator"></a>Q3DictIterator::Q3DictIterator ( const <a href="q3dict.html">Q3Dict</a><type> & <i>dict</i> )</h3>

<p>Constructs an iterator for <i>dict</i>. The current iterator item is set to point to the first item in the dictionary, <i>dict</i>. First in this context means first in the arbitrary traversal order.</p>

<h3 class="fn"><a name="dtor.Q3DictIterator"></a>Q3DictIterator::~Q3DictIterator ()</h3>

<p>Destroys the iterator.</p>

<h3 class="fn"><a name="count"></a><a href="qtglobal.html#uint-typedef">uint</a> Q3DictIterator::count () const</h3>

<p>Returns the number of items in the dictionary over which the iterator is operating.</p>

<p>See also <a href="q3dictiterator.html#isEmpty">isEmpty</a>().</p>

<h3 class="fn"><a name="current"></a>type * Q3DictIterator::current () const</h3>

<p>Returns a pointer to the current iterator item's value.</p>

<h3 class="fn"><a name="currentKey"></a><a href="qstring.html">QString</a> Q3DictIterator::currentKey () const</h3>

<p>Returns the current iterator item's key.</p>

<h3 class="fn"><a name="isEmpty"></a>bool Q3DictIterator::isEmpty () const</h3>

<p>Returns TRUE if the dictionary is empty, i.e. <a href="q3dictiterator.html#count">count</a>() == 0; otherwise returns FALSE.</p>

<p>See also <a href="q3dictiterator.html#count">count</a>().</p>

<h3 class="fn"><a name="toFirst"></a>type * Q3DictIterator::toFirst ()</h3>

<p>Resets the iterator, making the first item the first current item. First in this context means first in the arbitrary traversal order. Returns a pointer to this item.</p>

<p>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>Q3DictIterator::operator type * () const</h3>

<p>Cast operator. Returns a pointer to the current iterator item. Same as <a href="q3dictiterator.html#current">current</a>().</p>

<h3 class="fn"><a name="operator-28-29"></a>type * Q3DictIterator::operator() ()</h3>

<p>Makes the next 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 * Q3DictIterator::operator++ ()</h3>

<p>Prefix ++ makes the next 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>

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

100

101

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

102

</html>

Older »