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
|
/****************************************************************************
**
** Copyright (C) 2014 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 Q3ValueStack
\brief The Q3ValueStack class is a value-based template class that provides a stack.
\compat
Define a template instance Q3ValueStack\<X\> to create a stack of
values that all have the class X.
Note that Q3ValueStack does not store pointers to the members of
the stack; it holds a copy of every member. That is why these
kinds of classes are called "value based"; Q3PtrStack, Q3PtrList,
Q3Dict, etc., are "pointer based".
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(). The top() function provides access to the topmost item
without removing it.
Example:
\snippet doc/src/snippets/code/doc_src_q3valuestack.cpp 0
Q3ValueStack is a specialized Q3ValueList provided for convenience.
All of Q3ValueList's functionality also applies to Q3PtrStack, for
example the facility to iterate over all elements using
Q3ValueStack<T>::Iterator. See Q3ValueListIterator for further
details.
Some classes cannot be used within a Q3ValueStack, for example
everything derived from QObject and thus all classes that
implement widgets. Only values can be used in a Q3ValueStack. To
qualify as a value, the class must provide
\list
\i a copy constructor;
\i an assignment operator;
\i a default constructor, i.e. a constructor that does not take any arguments.
\endlist
Note that C++ defaults to field-by-field assignment operators and
copy constructors if no explicit version is supplied. In many
cases this is sufficient.
*/
/*!
\fn Q3ValueStack::Q3ValueStack()
Constructs an empty stack.
*/
/*!
\fn Q3ValueStack::~Q3ValueStack()
Destroys the stack. References to the values in the stack and all
iterators of this stack become invalidated. Because Q3ValueStack is
highly tuned for performance, you won't see warnings if you use
invalid iterators because it is impossible for an iterator to
check whether or not it is valid.
*/
/*!
\fn void Q3ValueStack::push( const T& d )
Adds element, \a d, to the top of the stack. Last in, first out.
This function is equivalent to append().
\sa pop(), top()
*/
/*!
\fn T& Q3ValueStack::top()
Returns a reference to the top item of the stack or the item
referenced by end() if no such item exists. Note that you must not
change the value the end() iterator points to.
This function is equivalent to last().
\sa pop(), push(), Q3ValueList::fromLast()
*/
/*!
\fn const T& Q3ValueStack::top() const
\overload
Returns a reference to the top item of the stack or the item
referenced by end() if no such item exists.
This function is equivalent to last().
\sa pop(), push(), Q3ValueList::fromLast()
*/
/*!
\fn T Q3ValueStack::pop()
Removes the top item from the stack and returns it.
\sa top() push()
*/
|
