source: trunk/doc/src/q3valuestack.qdoc@ 321

Last change on this file since 321 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.8 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 documentation 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 Q3ValueStack
44 \brief The Q3ValueStack class is a value-based template class that provides a stack.
45 \compat
46
47 Define a template instance Q3ValueStack\<X\> to create a stack of
48 values that all have the class X.
49
50 Note that Q3ValueStack does not store pointers to the members of
51 the stack; it holds a copy of every member. That is why these
52 kinds of classes are called "value based"; Q3PtrStack, Q3PtrList,
53 Q3Dict, etc., are "pointer based".
54
55 A stack is a last in, first out (LIFO) structure. Items are added
56 to the top of the stack with push() and retrieved from the top
57 with pop(). The top() function provides access to the topmost item
58 without removing it.
59
60 Example:
61 \snippet doc/src/snippets/code/doc_src_q3valuestack.qdoc 0
62
63 Q3ValueStack is a specialized Q3ValueList provided for convenience.
64 All of Q3ValueList's functionality also applies to Q3PtrStack, for
65 example the facility to iterate over all elements using
66 Q3ValueStack<T>::Iterator. See Q3ValueListIterator for further
67 details.
68
69 Some classes cannot be used within a Q3ValueStack, for example
70 everything derived from QObject and thus all classes that
71 implement widgets. Only values can be used in a Q3ValueStack. To
72 qualify as a value, the class must provide
73 \list
74 \i a copy constructor;
75 \i an assignment operator;
76 \i a default constructor, i.e. a constructor that does not take any arguments.
77 \endlist