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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- q3ptrdict.qdoc -->
<title>Qt 4.8: Q3PtrDictIterator Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li>Qt3SupportLight</li>
<li>Q3PtrDictIterator</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">Q3PtrDictIterator Class Reference</h1>
<!-- $$$Q3PtrDictIterator-brief -->
<p>The Q3PtrDictIterator class provides an iterator for <a href="q3ptrdict.html">Q3PtrDict</a> collections. <a href="#details">More...</a></p>
<!-- @@@Q3PtrDictIterator -->
<pre class="cpp"> <span class="preprocessor">#include <Q3PtrDictIterator></span></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 <a href="porting4.html">Porting to Qt 4</a> for more information.</p>
<ul>
<li><a href="q3ptrdictiterator-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3ptrdictiterator.html#Q3PtrDictIterator">Q3PtrDictIterator</a></b> ( const Q3PtrDict<type> & <i>dict</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3ptrdictiterator.html#dtor.Q3PtrDictIterator">~Q3PtrDictIterator</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> uint </td><td class="memItemRight bottomAlign"><b><a href="q3ptrdictiterator.html#count">count</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrdictiterator.html#current">current</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrdictiterator.html#currentKey">currentKey</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3ptrdictiterator.html#isEmpty">isEmpty</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrdictiterator.html#toFirst">toFirst</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3ptrdictiterator.html#operator-type--2a">operator type *</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrdictiterator.html#operator-28-29">operator()</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrdictiterator.html#operator-2b-2b">operator++</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrdictiterator.html#operator-2b-eq">operator+=</a></b> ( uint <i>jump</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$Q3PtrDictIterator-description -->
<div class="descr">
<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 class="cpp"> <span class="type"><a href="q3ptrdict.html">Q3PtrDict</a></span><span class="operator"><</span><span class="type">char</span><span class="operator">></span> fields;
<span class="type"><a href="qlineedit.html">QLineEdit</a></span> <span class="operator">*</span>le1 <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qlineedit.html">QLineEdit</a></span>( <span class="keyword">this</span> );
le1<span class="operator">-</span><span class="operator">></span>setText( <span class="string">"Simpson"</span> );
<span class="type"><a href="qlineedit.html">QLineEdit</a></span> <span class="operator">*</span>le2 <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qlineedit.html">QLineEdit</a></span>( <span class="keyword">this</span> );
le2<span class="operator">-</span><span class="operator">></span>setText( <span class="string">"Homer"</span> );
<span class="type"><a href="qlineedit.html">QLineEdit</a></span> <span class="operator">*</span>le3 <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qlineedit.html">QLineEdit</a></span>( <span class="keyword">this</span> );
le3<span class="operator">-</span><span class="operator">></span>setText( <span class="string">"45"</span> );
fields<span class="operator">.</span>insert( le1<span class="operator">,</span> <span class="string">"Surname"</span> );
fields<span class="operator">.</span>insert( le2<span class="operator">,</span> <span class="string">"Forename"</span> );
fields<span class="operator">.</span>insert( le3<span class="operator">,</span> <span class="string">"Age"</span> );
<span class="type">Q3PtrDictIterator</span><span class="operator"><</span><span class="type">char</span><span class="operator">></span> it( fields );
<span class="keyword">for</span>( ; it<span class="operator">.</span>current(); <span class="operator">+</span><span class="operator">+</span>it ) {
<span class="type"><a href="qlineedit.html">QLineEdit</a></span> <span class="operator">*</span>le <span class="operator">=</span> (<span class="type"><a href="qlineedit.html">QLineEdit</a></span>)it<span class="operator">.</span>currentKey();
cout <span class="operator"><</span><span class="operator"><</span> it<span class="operator">.</span>current() <span class="operator"><</span><span class="operator"><</span> <span class="string">": "</span> <span class="operator"><</span><span class="operator"><</span> le<span class="operator">-</span><span class="operator">></span>text() <span class="operator"><</span><span class="operator"><</span> endl;
}
cout <span class="operator"><</span><span class="operator"><</span> endl;
<span class="comment">// Output (random order):</span>
<span class="comment">// Forename: Homer</span>
<span class="comment">// Age: 45</span>
<span class="comment">// Surname: Simpson</span></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>
</div>
<p><b>See also </b><a href="q3ptrdict.html">Q3PtrDict</a>.</p>
<!-- @@@Q3PtrDictIterator -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Q3PtrDictIterator[overload1]$$$Q3PtrDictIteratorconstQ3PtrDict<type>& -->
<h3 class="fn"><a name="Q3PtrDictIterator"></a>Q3PtrDictIterator::<span class="name">Q3PtrDictIterator</span> ( const <span class="type"><a href="q3ptrdict.html">Q3PtrDict</a></span><<span class="type">type</span>> & <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>
<!-- @@@Q3PtrDictIterator -->
<!-- $$$~Q3PtrDictIterator[overload1]$$$~Q3PtrDictIterator -->
<h3 class="fn"><a name="dtor.Q3PtrDictIterator"></a>Q3PtrDictIterator::<span class="name">~Q3PtrDictIterator</span> ()</h3>
<p>Destroys the iterator.</p>
<!-- @@@~Q3PtrDictIterator -->
<!-- $$$count[overload1]$$$count -->
<h3 class="fn"><a name="count"></a><span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> Q3PtrDictIterator::<span class="name">count</span> () const</h3>
<p>Returns the number of items in the dictionary this iterator operates on.</p>
<p><b>See also </b><a href="q3ptrdictiterator.html#isEmpty">isEmpty</a>().</p>
<!-- @@@count -->
<!-- $$$current[overload1]$$$current -->
<h3 class="fn"><a name="current"></a><span class="type">type</span> * Q3PtrDictIterator::<span class="name">current</span> () const</h3>
<p>Returns a pointer to the current iterator item's value.</p>
<!-- @@@current -->
<!-- $$$currentKey[overload1]$$$currentKey -->
<h3 class="fn"><a name="currentKey"></a><span class="type">void</span> * Q3PtrDictIterator::<span class="name">currentKey</span> () const</h3>
<p>Returns the current iterator item's key.</p>
<!-- @@@currentKey -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn"><a name="isEmpty"></a><span class="type">bool</span> Q3PtrDictIterator::<span class="name">isEmpty</span> () const</h3>
<p>Returns TRUE if the dictionary is empty; otherwise returns FALSE.</p>
<p><b>See also </b><a href="q3ptrdictiterator.html#count">count</a>().</p>
<!-- @@@isEmpty -->
<!-- $$$toFirst[overload1]$$$toFirst -->
<h3 class="fn"><a name="toFirst"></a><span class="type">type</span> * Q3PtrDictIterator::<span class="name">toFirst</span> ()</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>
<!-- @@@toFirst -->
<!-- $$$operator type *[overload1]$$$operator type * -->
<h3 class="fn"><a name="operator-type--2a"></a>Q3PtrDictIterator::<span class="name">operator type *</span> () const</h3>
<p>Cast operator. Returns a pointer to the current iterator item. Same as <a href="q3ptrdictiterator.html#current">current</a>().</p>
<!-- @@@operator type * -->
<!-- $$$operator()[overload1]$$$operator() -->
<h3 class="fn"><a name="operator-28-29"></a><span class="type">type</span> * Q3PtrDictIterator::<span class="name">operator()</span> ()</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>
<!-- @@@operator() -->
<!-- $$$operator++[overload1]$$$operator++ -->
<h3 class="fn"><a name="operator-2b-2b"></a><span class="type">type</span> * Q3PtrDictIterator::<span class="name">operator++</span> ()</h3>
<p>Prefix ++ makes the succeeding 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>
<!-- @@@operator++ -->
<!-- $$$operator+=[overload1]$$$operator+=uint -->
<h3 class="fn"><a name="operator-2b-eq"></a><span class="type">type</span> * Q3PtrDictIterator::<span class="name">operator+=</span> ( <span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> <i>jump</i> )</h3>
<p>Sets the current item to the item <i>jump</i> positions after the current item and returns a pointer to that item.</p>
<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>
<!-- @@@operator+= -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>
|
