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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
<?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" />
<!-- q3ptrqueue.qdoc -->
<title>Qt 4.8: Q3PtrQueue 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>Q3PtrQueue</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="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">Q3PtrQueue Class Reference</h1>
<!-- $$$Q3PtrQueue-brief -->
<p>The Q3PtrQueue class is a template class that provides a queue. <a href="#details">More...</a></p>
<!-- @@@Q3PtrQueue -->
<pre class="cpp"> <span class="preprocessor">#include <Q3PtrQueue></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>
<p><b>Inherits: </b><a href="q3ptrcollection.html">Q3PtrCollection</a>.</p>
<ul>
<li><a href="q3ptrqueue-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="q3ptrqueue.html#Q3PtrQueue">Q3PtrQueue</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#Q3PtrQueue-2">Q3PtrQueue</a></b> ( const Q3PtrQueue<type> & <i>queue</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#dtor.Q3PtrQueue">~Q3PtrQueue</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#autoDelete">autoDelete</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#current">current</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#dequeue">dequeue</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#enqueue">enqueue</a></b> ( const type * <i>d</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> type * </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#head">head</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#isEmpty">isEmpty</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#remove">remove</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#setAutoDelete">setAutoDelete</a></b> ( bool <i>enable</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#operator-type--2a">operator type *</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Q3PtrQueue<type> & </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#operator-eq">operator=</a></b> ( const Q3PtrQueue<type> & <i>queue</i> )</td></tr>
</table>
<a name="reimplemented-public-functions"></a>
<h2>Reimplemented Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#clear">clear</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual uint </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#count">count</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">4 public functions inherited from <a href="q3ptrcollection.html#public-functions">Q3PtrCollection</a></li>
</ul>
<a name="reimplemented-protected-functions"></a>
<h2>Reimplemented Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QDataStream & </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#read">read</a></b> ( QDataStream & <i>s</i>, Q3PtrCollection::Item & <i>item</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QDataStream & </td><td class="memItemRight bottomAlign"><b><a href="q3ptrqueue.html#write">write</a></b> ( QDataStream & <i>s</i>, Q3PtrCollection::Item <i>item</i> ) const</td></tr>
</table>
<ul>
<li class="fn">2 protected functions inherited from <a href="q3ptrcollection.html#protected-functions">Q3PtrCollection</a></li>
</ul>
<a name="details"></a>
<!-- $$$Q3PtrQueue-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The Q3PtrQueue class is a template class that provides a queue.</p>
<p><a href="q3valuevector.html">Q3ValueVector</a> can be used as an STL-compatible alternative to this class.</p>
<p>A template instance Q3PtrQueue<X> is a queue that operates on pointers to X (X*).</p>
<p>A queue is a first in, first out structure. Items are added to the tail of the queue with <a href="q3ptrqueue.html#enqueue">enqueue</a>() and retrieved from the head with <a href="q3ptrqueue.html#dequeue">dequeue</a>(). You can peek at the head item without dequeing it using <a href="q3ptrqueue.html#head">head</a>().</p>
<p>You can control the queue's deletion policy with <a href="q3ptrqueue.html#setAutoDelete">setAutoDelete</a>().</p>
<p>For compatibility with the <a href="q3ptrcollection.html">Q3PtrCollection</a> classes, <a href="q3ptrqueue.html#current">current</a>() and <a href="q3ptrqueue.html#remove">remove</a>() are provided; both operate on the <a href="q3ptrqueue.html#head">head</a>().</p>
</div>
<p><b>See also </b><a href="q3ptrlist.html">Q3PtrList</a> and <a href="q3ptrstack.html">Q3PtrStack</a>.</p>
<!-- @@@Q3PtrQueue -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Q3PtrQueue[overload1]$$$Q3PtrQueue -->
<h3 class="fn"><a name="Q3PtrQueue"></a>Q3PtrQueue::<span class="name">Q3PtrQueue</span> ()</h3>
<p>Creates an empty queue with <a href="q3ptrqueue.html#autoDelete">autoDelete</a>() set to FALSE.</p>
<!-- @@@Q3PtrQueue -->
<!-- $$$Q3PtrQueue$$$Q3PtrQueueconstQ3PtrQueue<type>& -->
<h3 class="fn"><a name="Q3PtrQueue-2"></a>Q3PtrQueue::<span class="name">Q3PtrQueue</span> ( const <span class="type">Q3PtrQueue</span><<span class="type">type</span>> & <i>queue</i> )</h3>
<p>Creates a queue from <i>queue</i>.</p>
<p>Only the pointers are copied; the items are not. The <a href="q3ptrqueue.html#autoDelete">autoDelete</a>() flag is set to FALSE.</p>
<!-- @@@Q3PtrQueue -->
<!-- $$$~Q3PtrQueue[overload1]$$$~Q3PtrQueue -->
<h3 class="fn"><a name="dtor.Q3PtrQueue"></a>Q3PtrQueue::<span class="name">~Q3PtrQueue</span> ()</h3>
<p>Destroys the queue. Items in the queue are deleted if <a href="q3ptrqueue.html#autoDelete">autoDelete</a>() is TRUE.</p>
<!-- @@@~Q3PtrQueue -->
<!-- $$$autoDelete[overload1]$$$autoDelete -->
<h3 class="fn"><a name="autoDelete"></a><span class="type">bool</span> Q3PtrQueue::<span class="name">autoDelete</span> () const</h3>
<p>Returns the setting of the auto-delete option. The default is FALSE.</p>
<p><b>See also </b><a href="q3ptrqueue.html#setAutoDelete">setAutoDelete</a>().</p>
<!-- @@@autoDelete -->
<!-- $$$clear[overload1]$$$clear -->
<h3 class="fn"><a name="clear"></a><span class="type">void</span> Q3PtrQueue::<span class="name">clear</span> ()<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="q3ptrcollection.html#clear">Q3PtrCollection::clear</a>().</p>
<p>Removes all items from the queue, and deletes them if <a href="q3ptrqueue.html#autoDelete">autoDelete</a>() is TRUE.</p>
<p><b>See also </b><a href="q3ptrqueue.html#remove">remove</a>().</p>
<!-- @@@clear -->
<!-- $$$count[overload1]$$$count -->
<h3 class="fn"><a name="count"></a><span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> Q3PtrQueue::<span class="name">count</span> () const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="q3ptrcollection.html#count">Q3PtrCollection::count</a>().</p>
<p>Returns the number of items in the queue.</p>
<p><b>See also </b><a href="q3ptrqueue.html#isEmpty">isEmpty</a>().</p>
<!-- @@@count -->
<!-- $$$current[overload1]$$$current -->
<h3 class="fn"><a name="current"></a><span class="type">type</span> * Q3PtrQueue::<span class="name">current</span> () const</h3>
<p>Returns a pointer to the head item in the queue. The queue is not changed. Returns 0 if the queue is empty.</p>
<p><b>See also </b><a href="q3ptrqueue.html#dequeue">dequeue</a>() and <a href="q3ptrqueue.html#isEmpty">isEmpty</a>().</p>
<!-- @@@current -->
<!-- $$$dequeue[overload1]$$$dequeue -->
<h3 class="fn"><a name="dequeue"></a><span class="type">type</span> * Q3PtrQueue::<span class="name">dequeue</span> ()</h3>
<p>Takes the head item from the queue and returns a pointer to it. Returns 0 if the queue is empty.</p>
<p><b>See also </b><a href="q3ptrqueue.html#enqueue">enqueue</a>() and <a href="q3ptrqueue.html#count">count</a>().</p>
<!-- @@@dequeue -->
<!-- $$$enqueue[overload1]$$$enqueueconsttype* -->
<h3 class="fn"><a name="enqueue"></a><span class="type">void</span> Q3PtrQueue::<span class="name">enqueue</span> ( const <span class="type">type</span> * <i>d</i> )</h3>
<p>Adds item <i>d</i> to the tail of the queue.</p>
<p><b>See also </b><a href="q3ptrqueue.html#count">count</a>() and <a href="q3ptrqueue.html#dequeue">dequeue</a>().</p>
<!-- @@@enqueue -->
<!-- $$$head[overload1]$$$head -->
<h3 class="fn"><a name="head"></a><span class="type">type</span> * Q3PtrQueue::<span class="name">head</span> () const</h3>
<p>Returns a pointer to the head item in the queue. The queue is not changed. Returns 0 if the queue is empty.</p>
<p><b>See also </b><a href="q3ptrqueue.html#dequeue">dequeue</a>() and <a href="q3ptrqueue.html#isEmpty">isEmpty</a>().</p>
<!-- @@@head -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn"><a name="isEmpty"></a><span class="type">bool</span> Q3PtrQueue::<span class="name">isEmpty</span> () const</h3>
<p>Returns TRUE if the queue is empty; otherwise returns FALSE.</p>
<p><b>See also </b><a href="q3ptrqueue.html#count">count</a>(), <a href="q3ptrqueue.html#dequeue">dequeue</a>(), and <a href="q3ptrqueue.html#head">head</a>().</p>
<!-- @@@isEmpty -->
<!-- $$$read[overload1]$$$readQDataStream&Q3PtrCollection::Item& -->
<h3 class="fn"><a name="read"></a><span class="type"><a href="qdatastream.html">QDataStream</a></span> & Q3PtrQueue::<span class="name">read</span> ( <span class="type"><a href="qdatastream.html">QDataStream</a></span> & <i>s</i>, <span class="type"><a href="q3ptrcollection.html#Item-typedef">Q3PtrCollection::Item</a></span> & <i>item</i> )<tt> [virtual protected]</tt></h3>
<p>Reads a queue item, <i>item</i>, from the stream <i>s</i> and returns a reference to the stream.</p>
<p>The default implementation sets <i>item</i> to 0.</p>
<p><b>See also </b><a href="q3ptrqueue.html#write">write</a>().</p>
<!-- @@@read -->
<!-- $$$remove[overload1]$$$remove -->
<h3 class="fn"><a name="remove"></a><span class="type">bool</span> Q3PtrQueue::<span class="name">remove</span> ()</h3>
<p>Removes the head item from the queue, and returns TRUE if there was an item, i.e. the queue wasn't empty; otherwise returns FALSE.</p>
<p>The item is deleted if <a href="q3ptrqueue.html#autoDelete">autoDelete</a>() is TRUE.</p>
<p><b>See also </b><a href="q3ptrqueue.html#head">head</a>(), <a href="q3ptrqueue.html#isEmpty">isEmpty</a>(), and <a href="q3ptrqueue.html#dequeue">dequeue</a>().</p>
<!-- @@@remove -->
<!-- $$$setAutoDelete[overload1]$$$setAutoDeletebool -->
<h3 class="fn"><a name="setAutoDelete"></a><span class="type">void</span> Q3PtrQueue::<span class="name">setAutoDelete</span> ( <span class="type">bool</span> <i>enable</i> )</h3>
<p>Sets the queue to auto-delete its contents if <i>enable</i> is TRUE and not to delete them if <i>enable</i> is FALSE.</p>
<p>If auto-deleting is turned on, all the items in a queue are deleted when the queue itself is deleted. This can be quite convenient if the queue has the only pointer to the items.</p>
<p>The default setting is FALSE, for safety. If you turn it on, be careful about copying the queue: you might find yourself with two queues deleting the same items.</p>
<p><b>See also </b><a href="q3ptrqueue.html#autoDelete">autoDelete</a>().</p>
<!-- @@@setAutoDelete -->
<!-- $$$write[overload1]$$$writeQDataStream&Q3PtrCollection::Item -->
<h3 class="fn"><a name="write"></a><span class="type"><a href="qdatastream.html">QDataStream</a></span> & Q3PtrQueue::<span class="name">write</span> ( <span class="type"><a href="qdatastream.html">QDataStream</a></span> & <i>s</i>, <span class="type"><a href="q3ptrcollection.html#Item-typedef">Q3PtrCollection::Item</a></span> <i>item</i> ) const<tt> [virtual protected]</tt></h3>
<p>Writes a queue item, <i>item</i>, to the stream <i>s</i> and returns a reference to the stream.</p>
<p>The default implementation does nothing.</p>
<p><b>See also </b><a href="q3ptrqueue.html#read">read</a>().</p>
<!-- @@@write -->
<!-- $$$operator type *[overload1]$$$operator type * -->
<h3 class="fn"><a name="operator-type--2a"></a>Q3PtrQueue::<span class="name">operator type *</span> () const</h3>
<p>Returns a pointer to the head item in the queue. The queue is not changed. Returns 0 if the queue is empty.</p>
<p><b>See also </b><a href="q3ptrqueue.html#dequeue">dequeue</a>() and <a href="q3ptrqueue.html#isEmpty">isEmpty</a>().</p>
<!-- @@@operator type * -->
<!-- $$$operator=[overload1]$$$operator=constQ3PtrQueue<type>& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">Q3PtrQueue</span><<span class="type">type</span>> & Q3PtrQueue::<span class="name">operator=</span> ( const <span class="type">Q3PtrQueue</span><<span class="type">type</span>> & <i>queue</i> )</h3>
<p>Assigns <i>queue</i> to this queue and returns a reference to this queue.</p>
<p>This queue is first cleared and then each item in <i>queue</i> is enqueued to this queue. Only the pointers are copied.</p>
<p><b>Warning:</b> The <a href="q3ptrqueue.html#autoDelete">autoDelete</a>() flag is not modified. If it is TRUE for both <i>queue</i> and this queue, deleting the two lists will cause <i>double-deletion</i> of the items.</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>
|
