<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /tmp/qt-3.0-reggie-28534/qt-x11-free-3.0.2/doc/qptrdict.doc:303 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QPtrDictIterator Class</title>
<style type="text/css"><!--
h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td 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="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QPtrDictIterator Class Reference</h1>
<p>The QPtrDictIterator class provides an iterator for QPtrDict collections.
<a href="#details">More...</a>
<p><tt>#include <<a href="qptrdict-h.html">qptrdict.h</a>></tt>
<p><a href="qptrdictiterator-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li><div class=fn><a href="#QPtrDictIterator"><b>QPtrDictIterator</b></a> ( const QPtrDict<type> & dict )</div></li>
<li><div class=fn><a href="#~QPtrDictIterator"><b>~QPtrDictIterator</b></a> ()</div></li>
<li><div class=fn>uint <a href="#count"><b>count</b></a> () const</div></li>
<li><div class=fn>bool <a href="#isEmpty"><b>isEmpty</b></a> () const</div></li>
<li><div class=fn>type * <a href="#toFirst"><b>toFirst</b></a> ()</div></li>
<li><div class=fn><a href="#operator-type-*"><b>operator type *</b></a> () const</div></li>
<li><div class=fn>type * <a href="#current"><b>current</b></a> () const</div></li>
<li><div class=fn>void * <a href="#currentKey"><b>currentKey</b></a> () const</div></li>
<li><div class=fn>type * <a href="#operator()"><b>operator()</b></a> ()</div></li>
<li><div class=fn>type * <a href="#operator++"><b>operator++</b></a> ()</div></li>
<li><div class=fn>type * <a href="#operator+-eq"><b>operator+=</b></a> ( uint jump )</div></li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>
The QPtrDictIterator class provides an iterator for <a href="qptrdict.html">QPtrDict</a> collections.
<p>
<p> QPtrDictIterator is implemented as a template class.
Define a template instance QPtrDictIterator<X> to create a
dictionary iterator that operates on QPtrDict<X> (dictionary of X*).
<p> Example:
<pre>
<a href="qptrdict.html">QPtrDict</a><char> extra;
<a href="qlineedit.html">QLineEdit</a> *le1 = new <a href="qlineedit.html">QLineEdit</a>( this );
le1-><a href="qlineedit.html#setText">setText</a>( "Simpson" );
<a href="qlineedit.html">QLineEdit</a> *le2 = new <a href="qlineedit.html">QLineEdit</a>( this );
le2-><a href="qlineedit.html#setText">setText</a>( "Homer" );
<a href="qlineedit.html">QLineEdit</a> *le3 = new <a href="qlineedit.html">QLineEdit</a>( this );
le3-><a href="qlineedit.html#setText">setText</a>( "45" );
extra.<a href="qptrdict.html#insert">insert</a>( le1, "Surname" );
extra.<a href="qptrdict.html#insert">insert</a>( le2, "Forename" );
extra.<a href="qptrdict.html#insert">insert</a>( le3, "Age" );
QPtrDictIterator<char> it( extra );
for( ; it.<a href="#current">current</a>(); ++it ) {
<a href="qlineedit.html">QLineEdit</a> *le = (QLineEdit)it.<a href="#currentKey">currentKey</a>();
cout << it.<a href="#current">current</a>() << ": " << le-><a href="qlineedit.html#text">text</a>() << endl;
}
cout << endl;
// Output (random order):
// Forename: Homer
// Age: 45
// Surname: Simpson
</pre>
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> Multiple iterators may independently traverse the same dictionary.
A <a href="qptrdict.html">QPtrDict</a> knows about all iterators that are operating on the dictionary.
When an item is removed from the dictionary, QPtrDict updates all
iterators that refer the removed item to point to the next item
in the traversing order.
<p> <p>See also <a href="qptrdict.html">QPtrDict</a>, <a href="collection.html">Collection Classes</a> and <a href="tools.html">Non-GUI Classes</a>.
<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QPtrDictIterator"></a>QPtrDictIterator::QPtrDictIterator ( const <a href="qptrdict.html">QPtrDict</a><type> & dict )
</h3>
Constructs an iterator for <em>dict</em>. The current iterator item is
set to point on the first item in the <em>dict</em>.
<h3 class=fn><a name="~QPtrDictIterator"></a>QPtrDictIterator::~QPtrDictIterator ()
</h3>
Destroys the iterator.
<h3 class=fn>uint <a name="count"></a>QPtrDictIterator::count () const
</h3>
Returns the number of items in the dictionary this iterator operates on.
<p>See also <a href="#isEmpty">isEmpty</a>().
<h3 class=fn>type * <a name="current"></a>QPtrDictIterator::current () const
</h3>
Returns a pointer to the current iterator item.
<h3 class=fn>void * <a name="currentKey"></a>QPtrDictIterator::currentKey () const
</h3>
Returns the key for the current iterator item.
<h3 class=fn>bool <a name="isEmpty"></a>QPtrDictIterator::isEmpty () const
</h3>
Returns TRUE if the dictionary is empty; otherwise returns FALSE.
<p>See also <a href="#count">count</a>().
<h3 class=fn><a name="operator-type-*"></a>QPtrDictIterator::operator type * () const
</h3>
Cast operator. Returns a pointer to the current iterator item.
Same as <a href="#current">current</a>().
<h3 class=fn>type * <a name="operator()"></a>QPtrDictIterator::operator() ()
</h3>
Makes the succeeding item current and returns the original current item.
<p> If the current iterator item was the last item in the dictionary or if it
was null, null is returned.
<h3 class=fn>type * <a name="operator++"></a>QPtrDictIterator::operator++ ()
</h3>
Prefix ++ makes the succeeding item current and returns the new current
item.
<p> If the current iterator item was the last item in the dictionary or if it
was null, null is returned.
<h3 class=fn>type * <a name="operator+-eq"></a>QPtrDictIterator::operator+= ( uint jump )
</h3>
Sets the current item to the item <em>jump</em> positions after the current item
and returns a pointer to that item.
<p> If that item is beyond the last item or if the dictionary is empty,
it sets the current item to null and returns null.
<h3 class=fn>type * <a name="toFirst"></a>QPtrDictIterator::toFirst ()
</h3>
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 null and
returns null.
<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright © 1995-2001
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright © 2001
<a href="http://www.trolltech.com">Trolltech</a><td><a href="http://www.trolltech.com/trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt version 3.0.2</div>
</table></div></address></body>
</html>
distrib
>
Mandriva
>
8.2
>
i586
>
media
>
contrib
>
by-pkgid
>
112b0974ad288f6cd55bf971ee6026a9
>
files
>
1669
