You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tqt3/doc/html/tqptrdictiterator.html

181 lines
7.5 KiB

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>TQPtrDictIterator Class</title>
<style type="text/css"><!--
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&nbsp;Classes</font></a>
| <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
| <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
| <a href="groups.html">
<font color="#004faf">Grouped&nbsp;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>TQPtrDictIterator Class Reference</h1>
<p>The TQPtrDictIterator class provides an iterator for TQPtrDict collections.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="tqptrdict-h.html">tqptrdict.h</a>&gt;</tt>
<p><a href="tqptrdictiterator-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#TQPtrDictIterator"><b>TQPtrDictIterator</b></a> ( const&nbsp;TQPtrDict&lt;type&gt;&nbsp;&amp;&nbsp;dict )</li>
<li class=fn><a href="#~TQPtrDictIterator"><b>~TQPtrDictIterator</b></a> ()</li>
<li class=fn>uint <a href="#count"><b>count</b></a> () const</li>
<li class=fn>bool <a href="#isEmpty"><b>isEmpty</b></a> () const</li>
<li class=fn>type * <a href="#toFirst"><b>toFirst</b></a> ()</li>
<li class=fn><a href="#operator-type-*"><b>operator type *</b></a> () const</li>
<li class=fn>type * <a href="#current"><b>current</b></a> () const</li>
<li class=fn>void * <a href="#currentKey"><b>currentKey</b></a> () const</li>
<li class=fn>type * <a href="#operator()"><b>operator()</b></a> ()</li>
<li class=fn>type * <a href="#operator++"><b>operator++</b></a> ()</li>
<li class=fn>type * <a href="#operator+-eq"><b>operator+=</b></a> ( uint&nbsp;jump )</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>
The TQPtrDictIterator class provides an iterator for <a href="tqptrdict.html">TQPtrDict</a> collections.
<p>
<p> TQPtrDictIterator is implemented as a template class. Define a
template instance TQPtrDictIterator&lt;X&gt; to create a dictionary
iterator that operates on TQPtrDict&lt;X&gt; (dictionary of X*).
<p> Example:
<pre>
<a href="tqptrdict.html">TQPtrDict</a>&lt;char&gt; fields;
<a href="tqlineedit.html">TQLineEdit</a> *le1 = new <a href="tqlineedit.html">TQLineEdit</a>( this );
le1-&gt;<a href="tqlineedit.html#setText">setText</a>( "Simpson" );
<a href="tqlineedit.html">TQLineEdit</a> *le2 = new <a href="tqlineedit.html">TQLineEdit</a>( this );
le2-&gt;<a href="tqlineedit.html#setText">setText</a>( "Homer" );
<a href="tqlineedit.html">TQLineEdit</a> *le3 = new <a href="tqlineedit.html">TQLineEdit</a>( this );
le3-&gt;<a href="tqlineedit.html#setText">setText</a>( "45" );
fields.<a href="tqptrdict.html#insert">insert</a>( le1, "Surname" );
fields.<a href="tqptrdict.html#insert">insert</a>( le2, "Forename" );
fields.<a href="tqptrdict.html#insert">insert</a>( le3, "Age" );
TQPtrDictIterator&lt;char&gt; it( fields );
for( ; it.<a href="#current">current</a>(); ++it ) {
<a href="tqlineedit.html">TQLineEdit</a> *le = (TQLineEdit)it.<a href="#currentKey">currentKey</a>();
cout &lt;&lt; it.<a href="#current">current</a>() &lt;&lt; ": " &lt;&lt; le-&gt;<a href="tqlineedit.html#text">text</a>() &lt;&lt; endl;
}
cout &lt;&lt; endl;
// Output (random order):
// Forename: Homer
// Age: 45
// Surname: Simpson
</pre>
In the example we insert some line edits into a dictionary,
associating a string with each. We then iterate over the
dictionary printing the associated strings.
<p> Multiple iterators may independently traverse the same dictionary.
A <a href="tqptrdict.html">TQPtrDict</a> knows about all the iterators that are operating on the
dictionary. When an item is removed from the dictionary, TQPtrDict
updates all iterators that refer the removed item to point to the
next item in the traversing order.
<p> <p>See also <a href="tqptrdict.html">TQPtrDict</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="TQPtrDictIterator"></a>TQPtrDictIterator::TQPtrDictIterator ( const&nbsp;<a href="tqptrdict.html">TQPtrDict</a>&lt;type&gt;&nbsp;&amp;&nbsp;dict )
</h3>
<p> 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="~TQPtrDictIterator"></a>TQPtrDictIterator::~TQPtrDictIterator ()
</h3>
<p> Destroys the iterator.
<h3 class=fn>uint <a name="count"></a>TQPtrDictIterator::count () const
</h3>
<p> Returns the number of items in the dictionary this iterator
operates on.
<p> <p>See also <a href="#isEmpty">isEmpty</a>().
<h3 class=fn>type * <a name="current"></a>TQPtrDictIterator::current () const
</h3>
<p> Returns a pointer to the current iterator item's value.
<h3 class=fn>void * <a name="currentKey"></a>TQPtrDictIterator::currentKey () const
</h3>
<p> Returns the current iterator item's key.
<h3 class=fn>bool <a name="isEmpty"></a>TQPtrDictIterator::isEmpty () const
</h3>
<p> Returns TRUE if the dictionary is empty; otherwise returns FALSE.
<p> <p>See also <a href="#count">count</a>().
<h3 class=fn><a name="operator-type-*"></a>TQPtrDictIterator::operator type * () const
</h3>
<p> 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>TQPtrDictIterator::operator() ()
</h3>
<p> 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 0, 0 is returned.
<h3 class=fn>type * <a name="operator++"></a>TQPtrDictIterator::operator++ ()
</h3>
<p> 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 0, 0 is returned.
<h3 class=fn>type * <a name="operator+-eq"></a>TQPtrDictIterator::operator+= ( uint&nbsp;jump )
</h3>
<p> 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 0 and returns 0.
<h3 class=fn>type * <a name="toFirst"></a>TQPtrDictIterator::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.
<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">TQt toolkit</a>.
Copyright &copy; 1995-2007
<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 &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>TQt 3.3.8</div>
</table></div></address></body>
</html>