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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
/*!
\class QQueue
\inmodule QtCore
\brief The QQueue class is a generic container that provides a queue.
\ingroup tools
\ingroup shared
\reentrant
QQueue\<T\> is one of Qt's generic \l{container classes}. It
implements a queue data structure for items of a same type.
A queue is a first in, first out (FIFO) structure. Items are
added to the tail of the queue using enqueue() and retrieved from
the head using dequeue(). The head() function provides access to
the head item without removing it.
Example:
\snippet code/src_corelib_tools_qqueue.cpp 0
The example will output 1, 2, 3 in that order.
QQueue inherits from QList. All of QList's functionality also
applies to QQueue. For example, you can use isEmpty() to test
whether the queue is empty, and you can traverse a QQueue using
QList's iterator classes (for example, QListIterator). But in
addition, QQueue provides three convenience functions that make
it easy to implement FIFO semantics: enqueue(), dequeue(), and
head().
QQueue's value type must be an \l{assignable data type}. This
covers most data types that are commonly used, but the compiler
won't let you, for example, store a QWidget as a value. Use
QWidget* instead.
\sa QList, QStack
*/
/*!
\fn template <class T> void QQueue<T>::swap(QQueue<T> &other)
\since 4.8
Swaps queue \a other with this queue. This operation is very
fast and never fails.
*/
/*!
\fn template <class T> void QQueue<T>::enqueue(const T& t)
Adds value \a t to the tail of the queue.
This is the same as QList::append().
\sa dequeue(), head()
*/
/*!
\fn template <class T> T &QQueue<T>::head()
Returns a reference to the queue's head item. This function
assumes that the queue isn't empty.
This is the same as QList::first().
\sa dequeue(), enqueue(), isEmpty()
*/
/*!
\fn template <class T> const T &QQueue<T>::head() const
\overload
*/
/*!
\fn template <class T> T QQueue<T>::dequeue()
Removes the head item in the queue and returns it. This function
assumes that the queue isn't empty.
This is the same as QList::takeFirst().
\sa head(), enqueue(), isEmpty()
*/
|
