source: trunk/src/corelib/tools/qqueue.cpp@ 104

Last change on this file since 104 was 2, checked in by Dmitry A. Kuminov, 16 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.
File size: 4.1 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information ([email protected])
5**
6** This file is part of the QtCore module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file. Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you are unsure which license is appropriate for your use, please
37** contact the sales department at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42/*!
43 \class QQueue
44 \brief The QQueue class is a generic container that provides a queue.
45
46 \ingroup tools
47 \ingroup shared
48 \mainclass
49 \reentrant
50
51 QQueue\<T\> is one of Qt's generic \l{container classes}. It
52 implements a queue data structure for items of a same type.
53
54 A queue is a first in, first out (FIFO) structure. Items are
55 added to the tail of the queue using enqueue() and retrieved from
56 the head using dequeue(). The head() function provides access to
57 the head item without removing it.
58
59 Example:
60 \snippet doc/src/snippets/code/src_corelib_tools_qqueue.cpp 0
61
62 The example will output 1, 2, 3 in that order.
63
64 QQueue inherits from QList. All of QList's functionality also
65 applies to QQueue. For example, you can use isEmpty() to test
66 whether the queue is empty, and you can traverse a QQueue using
67 QList's iterator classes (for example, QListIterator). But in
68 addition, QQueue provides three convenience functions that make
69 it easy to implement FIFO semantics: enqueue(), dequeue(), and
70 head().
71
72 QQueue's value type must be an \l{assignable data type}. This
73 covers most data types that are commonly used, but the compiler
74 won't let you, for example, store a QWidget as a value. Use
75 QWidget* instead.
76
77 \sa QList, QStack
78*/
79
80/*!
81 \fn QQueue::QQueue()
82
83 Constructs an empty queue.
84*/
85
86/*!
87 \fn QQueue::~QQueue()
88
89 Destroys the queue. References to the values in the queue, and all
90 iterators over this queue, become invalid.
91*/
92
93/*!
94 \fn void QQueue::enqueue(const T& t)
95
96 Adds value \a t to the tail of the queue.
97
98 This is the same as QList::append().
99
100 \sa dequeue(), head()
101*/
102
103/*!
104 \fn T &QQueue::head()
105
106 Returns a reference to the queue's head item. This function
107 assumes that the queue isn't empty.
108
109 This is the same as QList::first().
110
111 \sa dequeue(), enqueue(), isEmpty()
112*/
113
114/*!
115 \fn const T &QQueue::head() const
116
117 \overload
118*/
119
120/*!
121 \fn T QQueue::dequeue()
122
123 Removes the head item in the queue and returns it. This function
124 assumes that the queue isn't empty.
125
126 This is the same as QList::takeFirst().
127
128 \sa head(), enqueue(), isEmpty()
129*/
Note: See TracBrowser for help on using the repository browser.