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
211
212
213
214
215
216
|
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\class Q3PtrQueue
\brief The Q3PtrQueue class is a template class that provides a queue.
\compat
Q3ValueVector can be used as an STL-compatible alternative to this
class.
A template instance Q3PtrQueue\<X\> is a queue that operates on
pointers to X (X*).
A queue is a first in, first out structure. Items are added to the
tail of the queue with enqueue() and retrieved from the head with
dequeue(). You can peek at the head item without dequeing it using
head().
You can control the queue's deletion policy with setAutoDelete().
For compatibility with the Q3PtrCollection classes, current() and
remove() are provided; both operate on the head().
\sa Q3PtrList Q3PtrStack
*/
/*!
\fn Q3PtrQueue::Q3PtrQueue ()
Creates an empty queue with autoDelete() set to FALSE.
*/
/*!
\fn Q3PtrQueue::Q3PtrQueue( const Q3PtrQueue<type>& queue )
Creates a queue from \a queue.
Only the pointers are copied; the items are not. The autoDelete()
flag is set to FALSE.
*/
/*!
\fn Q3PtrQueue::~Q3PtrQueue()
Destroys the queue. Items in the queue are deleted if autoDelete()
is TRUE.
*/
/*!
\fn Q3PtrQueue<type>& Q3PtrQueue::operator= (const Q3PtrQueue<type>& queue)
Assigns \a queue to this queue and returns a reference to this
queue.
This queue is first cleared and then each item in \a queue is
enqueued to this queue. Only the pointers are copied.
\warning The autoDelete() flag is not modified. If it is TRUE for
both \a queue and this queue, deleting the two lists will cause \e
double-deletion of the items.
*/
/*!
\fn bool Q3PtrQueue::isEmpty() const
Returns TRUE if the queue is empty; otherwise returns FALSE.
\sa count() dequeue() head()
*/
/*!
\fn void Q3PtrQueue::enqueue (const type* d)
Adds item \a d to the tail of the queue.
\sa count() dequeue()
*/
/*!
\fn type* Q3PtrQueue::dequeue ()
Takes the head item from the queue and returns a pointer to it.
Returns 0 if the queue is empty.
\sa enqueue() count()
*/
/*!
\fn bool Q3PtrQueue::remove()
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.
The item is deleted if autoDelete() is TRUE.
\sa head() isEmpty() dequeue()
*/
/*!
\fn void Q3PtrQueue::clear()
Removes all items from the queue, and deletes them if autoDelete()
is TRUE.
\sa remove()
*/
/*!
\fn uint Q3PtrQueue::count() const
Returns the number of items in the queue.
\sa isEmpty()
*/
/*!
\fn type* Q3PtrQueue::head() const
Returns a pointer to the head item in the queue. The queue is not
changed. Returns 0 if the queue is empty.
\sa dequeue() isEmpty()
*/
/*!
\fn Q3PtrQueue::operator type*() const
Returns a pointer to the head item in the queue. The queue is not
changed. Returns 0 if the queue is empty.
\sa dequeue() isEmpty()
*/
/*!
\fn type* Q3PtrQueue::current() const
Returns a pointer to the head item in the queue. The queue is not
changed. Returns 0 if the queue is empty.
\sa dequeue() isEmpty()
*/
/*!
\fn bool Q3PtrQueue::autoDelete() const
Returns the setting of the auto-delete option. The default is
FALSE.
\sa setAutoDelete()
*/
/*!
\fn void Q3PtrQueue::setAutoDelete( bool enable )
Sets the queue to auto-delete its contents if \a enable is TRUE
and not to delete them if \a enable is FALSE.
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.
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.
\sa autoDelete()
*/
/*!
\fn QDataStream& Q3PtrQueue::read( QDataStream& s,
Q3PtrCollection::Item& item )
Reads a queue item, \a item, from the stream \a s and returns a
reference to the stream.
The default implementation sets \a item to 0.
\sa write()
*/
/*!
\fn QDataStream& Q3PtrQueue::write( QDataStream& s,
Q3PtrCollection::Item item ) const
Writes a queue item, \a item, to the stream \a s and returns a
reference to the stream.
The default implementation does nothing.
\sa read()
*/
|
