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

<p>The Q3PtrDictIterator class provides an iterator for <a href="q3ptrdict.html">Q3PtrDict</a> collections. <a href="#details">More...</a></p>

<pre>#include <Q3PtrDictIterator></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="q3ptrdictiterator-members.html">List of all members, including inherited members</a></li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="q3ptrdictiterator.html#Q3PtrDictIterator">Q3PtrDictIterator</a></b> ( const Q3PtrDict<type> & <i>dict</i> )</li>

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

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

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

<li><div class="fn"/>void * <b><a href="q3ptrdictiterator.html#currentKey">currentKey</a></b> () const</li>

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

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

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

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

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

<li><div class="fn"/>type * <b><a href="q3ptrdictiterator.html#operator-2b-eq">operator+=</a></b> ( uint <i>jump</i> )</li>

</ul>

<hr />

<h2>Detailed Description</h2>

<p>The Q3PtrDictIterator class provides an iterator for <a href="q3ptrdict.html">Q3PtrDict</a> collections.</p>

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

<p>Example:</p>

<pre>  Q3PtrDict<char> fields;

QLineEdit *le1 = new QLineEdit( this );

le1->setText( "Simpson" );

QLineEdit *le2 = new QLineEdit( this );

le2->setText( "Homer" );

QLineEdit *le3 = new QLineEdit( this );

le3->setText( "45" );

fields.insert( le1, "Surname" );

fields.insert( le2, "Forename" );

fields.insert( le3, "Age" );

Q3PtrDictIterator<char> it( fields );

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

QLineEdit *le = (QLineEdit)it.currentKey();

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

}

cout << endl;

// Output (random order):

// Forename: Homer

// Age: 45

// Surname: Simpson</pre>

<p>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>

<p>Multiple iterators may independently traverse the same dictionary. A <a href="q3ptrdict.html">Q3PtrDict</a> knows about all the iterators that are operating on the dictionary. When an item is removed from the dictionary, <a href="q3ptrdict.html">Q3PtrDict</a> updates all iterators that refer the removed item to point to the next item in the traversing order.</p>

<p>See also <a href="q3ptrdict.html">Q3PtrDict</a>.</p>

<hr />

<h2>Member Function Documentation</h2>

<h3 class="fn"><a name="Q3PtrDictIterator"></a>Q3PtrDictIterator::Q3PtrDictIterator ( const <a href="q3ptrdict.html">Q3PtrDict</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.Q3PtrDictIterator"></a>Q3PtrDictIterator::~Q3PtrDictIterator ()</h3>

<p>Destroys the iterator.</p>

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

<p>Returns the number of items in the dictionary this iterator operates on.</p>

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

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

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

<h3 class="fn"><a name="currentKey"></a>void * Q3PtrDictIterator::currentKey () const</h3>

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

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

<p>Returns TRUE if the dictionary is empty; otherwise returns FALSE.</p>

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

<h3 class="fn"><a name="toFirst"></a>type * Q3PtrDictIterator::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>Q3PtrDictIterator::operator type * () const</h3>

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

<h3 class="fn"><a name="operator-28-29"></a>type * Q3PtrDictIterator::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 * Q3PtrDictIterator::operator++ ()</h3>

<p>Prefix ++ makes the succeeding item current and returns the new current item.</p>

100

<p>If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned.</p>

101

<h3 class="fn"><a name="operator-2b-eq"></a>type * Q3PtrDictIterator::operator+= ( <a href="qtglobal.html#uint-typedef">uint</a> <i>jump</i> )</h3>

102

<p>Sets the current item to the item <i>jump</i> positions after the current item and returns a pointer to that item.</p>

103

<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>

104

105

106

107

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

108

109

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

110

</html>

Older »