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
|
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Free Documentation License
** 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.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\class Q3PtrStack
\brief The Q3PtrStack class is a template class that provides a stack.
\compat
Q3ValueStack is an STL-compatible alternative to this class.
Define a template instance Q3PtrStack\<X\> to create a stack that
operates on pointers to X, (X*).
A stack is a last in, first out (LIFO) structure. Items are added
to the top of the stack with push() and retrieved from the top
with pop(). Use top() to get a reference to the top element
without changing the stack.
You can control the stack's deletion policy with setAutoDelete().
For compatibility with the Q3PtrCollection classes current() and
remove() are provided; they both operate on the top().
\sa Q3PtrList Q3PtrQueue
*/
/*!
\fn Q3PtrStack::Q3PtrStack ()
Creates an empty stack.
*/
/*!
\fn Q3PtrStack::Q3PtrStack (const Q3PtrStack<type>& s)
Creates a stack by making a shallow copy of another stack \a s.
*/
/*!
\fn Q3PtrStack::~Q3PtrStack ()
Destroys the stack. All items will be deleted if autoDelete() is
true.
*/
/*!
\fn Q3PtrStack<type>& Q3PtrStack::operator= (const Q3PtrStack<type>& s)
Sets the contents of this stack by making a shallow copy of
another stack \a s. Elements currently in this stack will be
deleted if autoDelete() is true.
*/
/*!
\fn bool Q3PtrStack::isEmpty () const
Returns true if the stack contains no elements; otherwise returns
false.
*/
/*!
\fn void Q3PtrStack::push (const type* d)
Adds an element \a d to the top of the stack. Last in, first out.
*/
/*!
\fn type* Q3PtrStack::pop ()
Removes the top item from the stack and returns it. The stack must
not be empty.
*/
/*!
\fn bool Q3PtrStack::remove ()
Removes the top item from the stack and deletes it if autoDelete()
is true. Returns true if there was an item to pop; otherwise
returns false.
\sa clear()
*/
/*!
\fn void Q3PtrStack::clear()
Removes all items from the stack, deleting them if autoDelete() is
true.
\sa remove()
*/
/*!
\fn uint Q3PtrStack::count() const
Returns the number of items in the stack.
\sa isEmpty()
*/
/*!
\fn type* Q3PtrStack::top () const
Returns a pointer to the top item on the stack (most recently
pushed). The stack is not changed. Returns 0 if the stack is
empty.
*/
/*!
\fn Q3PtrStack::operator type* ()const
Returns a pointer to the top item on the stack (most recently
pushed). The stack is not changed. Returns 0 if the stack is
empty.
*/
/*!
\fn type* Q3PtrStack::current () const
Returns a pointer to the top item on the stack (most recently
pushed). The stack is not changed. Returns 0 if the stack is
empty.
*/
/*!
\fn bool Q3PtrStack::autoDelete() const
The same as Q3PtrCollection::autoDelete(). Returns true if
the auto-delete option is set. If the option is set, the
stack auto-deletes its contents.
\sa setAutoDelete()
*/
/*!
\fn void Q3PtrStack::setAutoDelete(bool enable)
Defines whether this stack auto-deletes its contents. The same as
Q3PtrCollection::setAutoDelete(). If \a enable is true, auto-delete
is turned on.
If auto-deleting is turned on, all the items in the stack are
deleted when the stack itself is deleted. This is convenient if
the stack has the only pointers to the items.
The default setting is false, for safety. If you turn it on, be
careful about copying the stack, or you might find yourself with
two stacks deleting the same items.
Note that the auto-delete setting may also affect other functions in
subclasses. For example, a subclass that has a remove() function
will remove the item from its data structure, and if auto-delete is
enabled, will also delete the item.
\sa autoDelete()
*/
/*!
\fn QDataStream& Q3PtrStack::read(QDataStream& s, Q3PtrCollection::Item& item)
Reads a stack 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& Q3PtrStack::write(QDataStream& s,
Q3PtrCollection::Item item) const
Writes a stack item, \a item, to the stream \a s and returns a
reference to the stream.
The default implementation does nothing.
\sa read()
*/
|
