|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the QtCore module of the Qt Toolkit. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 /*! |
|
43 \class QStack |
|
44 \brief The QStack class is a template class that provides a stack. |
|
45 |
|
46 \ingroup tools |
|
47 \ingroup shared |
|
48 |
|
49 \reentrant |
|
50 |
|
51 QStack\<T\> is one of Qt's generic \l{container classes}. It implements |
|
52 a stack data structure for items of a same type. |
|
53 |
|
54 A stack is a last in, first out (LIFO) structure. Items are added |
|
55 to the top of the stack using push() and retrieved from the top |
|
56 using pop(). The top() function provides access to the topmost |
|
57 item without removing it. |
|
58 |
|
59 Example: |
|
60 |
|
61 \snippet doc/src/snippets/qstack/main.cpp 0 |
|
62 |
|
63 The example will output 3, 2, 1 in that order. |
|
64 |
|
65 QStack inherits from QVector. All of QVector's functionality also |
|
66 applies to QStack. For example, you can use isEmpty() to test |
|
67 whether the stack is empty, and you can traverse a QStack using |
|
68 QVector's iterator classes (for example, QVectorIterator). But in |
|
69 addition, QStack provides three convenience functions that make |
|
70 it easy to implement LIFO semantics: push(), pop(), and top(). |
|
71 |
|
72 QStack'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; instead, |
|
75 store a QWidget *. |
|
76 |
|
77 \sa QVector, QQueue |
|
78 */ |
|
79 |
|
80 /*! |
|
81 \fn QStack::QStack() |
|
82 |
|
83 Constructs an empty stack. |
|
84 */ |
|
85 |
|
86 /*! |
|
87 \fn QStack::~QStack() |
|
88 |
|
89 Destroys the stack. References to the values in the stack, and all |
|
90 iterators over this stack, become invalid. |
|
91 */ |
|
92 |
|
93 /*! |
|
94 \fn void QStack::push(const T& t) |
|
95 |
|
96 Adds element \a t to the top of the stack. |
|
97 |
|
98 This is the same as QVector::append(). |
|
99 |
|
100 \sa pop(), top() |
|
101 */ |
|
102 |
|
103 /*! |
|
104 \fn T& QStack::top() |
|
105 |
|
106 Returns a reference to the stack's top item. This function |
|
107 assumes that the stack isn't empty. |
|
108 |
|
109 This is the same as QVector::last(). |
|
110 |
|
111 \sa pop(), push(), isEmpty() |
|
112 */ |
|
113 |
|
114 /*! |
|
115 \fn const T& QStack::top() const |
|
116 |
|
117 \overload |
|
118 |
|
119 \sa pop(), push() |
|
120 */ |
|
121 |
|
122 /*! |
|
123 \fn T QStack::pop() |
|
124 |
|
125 Removes the top item from the stack and returns it. This function |
|
126 assumes that the stack isn't empty. |
|
127 |
|
128 \sa top(), push(), isEmpty() |
|
129 */ |