QValueStack(3qt)QValueStack(3qt)NAMEQValueStack - Value-based template class that provides a stack
SYNOPSIS
All the functions in this class are reentrant when Qt is built with
thread support.</p>
#include <qvaluestack.h>
Inherits QValueList<T>.
Public Members
QValueStack ()
~QValueStack ()
void push ( const T & d )
T pop ()
T & top ()
const T & top () const
DESCRIPTION
The QValueStack class is a value-based template class that provides a
stack.
Define a template instance QValueStack<X> to create a stack of values
that all have the class X. QValueStack is part of the Qt Template
Library.
Note that QValueStack 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"; QPtrStack, QPtrList, QDict, 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:
QValueStack<int> stack;
stack.push( 1 );
stack.push( 2 );
stack.push( 3 );
while ( ! stack.isEmpty() )
cout << "Item: " << stack.pop() << endl;
// Output:
// Item: 3
// Item: 2
// Item: 1
QValueStack is a specialized QValueList provided for convenience. All
of QValueList's functionality also applies to QPtrStack, for example
the facility to iterate over all elements using
QValueStack<T>::Iterator. See QValueListIterator for further details.
Some classes cannot be used within a QValueStack, for example
everything derived from QObject and thus all classes that implement
widgets. Only values can be used in a QValueStack. To qualify as a
value, the class must provide
a copy constructor;
an assignment operator;
a default constructor, i.e. a constructor that does not take any
arguments.
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.
See also Qt Template Library Classes, Implicitly and Explicitly Shared
Classes, and Non-GUI Classes.
MEMBER FUNCTION DOCUMENTATIONQValueStack::QValueStack ()
Constructs an empty stack.
QValueStack::~QValueStack ()
Destroys the stack. References to the values in the stack and all
iterators of this stack become invalidated. Because QValueStack 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.
T QValueStack::pop ()
Removes the top item from the stack and returns it.
See also top() and push().
void QValueStack::push ( const T & d )
Adds element, d, to the top of the stack. Last in, first out.
This function is equivalent to append().
See also pop() and top().
T & QValueStack::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().
See also pop(), push(), and QValueList::fromLast().
const T & QValueStack::top () const
This is an overloaded member function, provided for convenience. It
behaves essentially like the above function.
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().
See also pop(), push(), and QValueList::fromLast().
SEE ALSO
http://doc.trolltech.com/qvaluestack.html
http://www.trolltech.com/faq/tech.html
COPYRIGHT
Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the
license file included in the distribution for a complete license
statement.
AUTHOR
Generated automatically from the source code.
BUGS
If you find a bug in Qt, please report it as described in
http://doc.trolltech.com/bughowto.html. Good bug reports help us to
help you. Thank you.
The definitive Qt documentation is provided in HTML format; it is
located at $QTDIR/doc/html and can be read using Qt Assistant or with a
web browser. This man page is provided as a convenience for those users
who prefer man pages, although this format is not officially supported
by Trolltech.
If you find errors in this manual page, please report them to qt-
bugs@trolltech.com. Please include the name of the manual page
(qvaluestack.3qt) and the Qt version (3.3.8).
Trolltech AS 2 February 2007 QValueStack(3qt)