summaryrefslogtreecommitdiffstats
path: root/doc/html/qptrdictiterator.html
blob: 8ab9068087db9b515b4ad3bea6a432a566ec4996 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/doc/qptrdict.doc:319 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QPtrDictIterator 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>QPtrDictIterator Class Reference</h1>

<p>The QPtrDictIterator class provides an iterator for QPtrDict collections.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qptrdict-h.html">qptrdict.h</a>&gt;</tt>
<p><a href="qptrdictiterator-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QPtrDictIterator"><b>QPtrDictIterator</b></a> ( const&nbsp;QPtrDict&lt;type&gt;&nbsp;&amp;&nbsp;dict )</li>
<li class=fn><a href="#~QPtrDictIterator"><b>~QPtrDictIterator</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 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&lt;X&gt; to create a dictionary
iterator that operates on QPtrDict&lt;X&gt; (dictionary of X*).
<p> Example:
<pre>
    <a href="qptrdict.html">QPtrDict</a>&lt;char&gt; fields;

    <a href="qlineedit.html">QLineEdit</a> *le1 = new <a href="qlineedit.html">QLineEdit</a>( this );
    le1-&gt;<a href="qlineedit.html#setText">setText</a>( "Simpson" );
    <a href="qlineedit.html">QLineEdit</a> *le2 = new <a href="qlineedit.html">QLineEdit</a>( this );
    le2-&gt;<a href="qlineedit.html#setText">setText</a>( "Homer" );
    <a href="qlineedit.html">QLineEdit</a> *le3 = new <a href="qlineedit.html">QLineEdit</a>( this );
    le3-&gt;<a href="qlineedit.html#setText">setText</a>( "45" );

    fields.<a href="qptrdict.html#insert">insert</a>( le1, "Surname" );
    fields.<a href="qptrdict.html#insert">insert</a>( le2, "Forename" );
    fields.<a href="qptrdict.html#insert">insert</a>( le3, "Age" );

    QPtrDictIterator&lt;char&gt; it( fields );
    for( ; it.<a href="#current">current</a>(); ++it ) {
        <a href="qlineedit.html">QLineEdit</a> *le = (QLineEdit)it.<a href="#currentKey">currentKey</a>();
        cout &lt;&lt; it.<a href="#current">current</a>() &lt;&lt; ": " &lt;&lt; le-&gt;<a href="qlineedit.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="qptrdict.html">QPtrDict</a> knows about all the 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&nbsp;<a href="qptrdict.html">QPtrDict</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="~QPtrDictIterator"></a>QPtrDictIterator::~QPtrDictIterator ()
</h3>

<p> Destroys the iterator.

<h3 class=fn>uint <a name="count"></a>QPtrDictIterator::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>QPtrDictIterator::current () const
</h3>

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

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

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

<h3 class=fn>bool <a name="isEmpty"></a>QPtrDictIterator::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>QPtrDictIterator::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>QPtrDictIterator::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>QPtrDictIterator::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>QPtrDictIterator::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>QPtrDictIterator::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">Qt 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>Qt 3.3.8</div>
</table></div></address></body>
</html>