summaryrefslogtreecommitdiffstats
path: root/qtools/qstack.doc
blob: ece1e2a15e2e2fa76be9ae90ab126d96a6be9414 (plain)
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
/****************************************************************************
** 
**
** QStack class documentation
**
** Copyright (C) 1992-2000 Trolltech AS.  All rights reserved.
**
** This file is part of the Qt GUI Toolkit.
**
** This file may be distributed under the terms of the Q Public License
** as defined by Trolltech AS of Norway and appearing in the file
** LICENSE.QPL included in the packaging of this file.
**
** This file may be distributed and/or modified under the terms of the
** GNU General Public License version 2 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.
**
** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
** licenses may use this file in accordance with the Qt Commercial License
** Agreement provided with the Software.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
**   information about Qt Commercial License Agreements.
** See http://www.trolltech.com/qpl/ for QPL licensing information.
** See http://www.trolltech.com/gpl/ for GPL licensing information.
**
** Contact info@trolltech.com if any conditions of this licensing are
** not clear to you.
**
**********************************************************************/


/*****************************************************************************
  QStack documentation
 *****************************************************************************/

/*!
  \class QStack qstack.h
  \brief The QStack class is a template class that provides a stack.

  \ingroup collection
  \ingroup tools

  QStack is implemented as a template class. Define a template
  instance QStack\<X\> to create a stack that operates on pointers to
  X, or 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().

  \sa \link collection.html Collection Classes\endlink
*/

/*! \fn QStack::QStack () 
  Creates and empty stack.
*/

/*! \fn QStack::QStack (const QStack<type>& s) 
  Creates a stack by making a shallow copy of another stack.
*/

/*! \fn QStack::~QStack () 
  Destroys the stack.  All items will be deleted if autoDelete() is TRUE.
*/

/*! \fn QStack<type>& QStack::operator= (const QStack<type>& s) 
  Sets the contents of this stack by making a shallow copy of another stack.
  Elements currently in this stack will be deleted if autoDelete() is TRUE.
*/

/*! \fn bool QStack::isEmpty () const 
  Returns TRUE is the stack contains no elements to be \link pop() popped\endlink.
*/

/*! \fn void QStack::push (const type* d) 
  Adds an element to the top of the stack.  Last in, first out.
*/

/*! \fn type* QStack::pop () 
  Removes the top item from the stack and returns it.
*/

/*! \fn bool QStack::remove () 
  Removes the top item from the stack and deletes it if
  autoDelete() is TRUE.  Returns TRUE if there was an item to pop.

  \sa clear()
*/

/*! \fn void QStack::clear()
  Removes all items from the stack, deleting them if
  autoDelete() is TRUE.

  \sa remove()
*/

/*! \fn uint QStack::count() const
  Returns the number of items in the stack.

  \sa isEmpty()
*/

/*! \fn type* QStack::top () const 
  Returns a reference to the top item on the stack (most recently pushed).
  The stack is not changed.
*/

/*! \fn QStack::operator type* ()const 
  Returns a reference to the top item on the stack (most recently pushed).
  The stack is not changed.
*/

/*! \fn type* QStack::current () const 
  Returns a reference to the top item on the stack (most recently pushed).
  The stack is not changed.
*/

/*! \fn bool QStack::autoDelete() const

  The same as QCollection::autoDelete().

  \sa setAutoDelete()
*/

/*! \fn void QStack::setAutoDelete( bool enable ) 

  The same as QCollection::setAutoDelete().
 
  \sa autoDelete()
*/