From bd0f3345a938b35ce6a12f6150373b0955b8dd12 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Sun, 10 Jul 2011 15:24:15 -0500 Subject: Add Qt3 development HEAD version --- doc/html/qvaluestack.html | 158 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 158 insertions(+) create mode 100644 doc/html/qvaluestack.html (limited to 'doc/html/qvaluestack.html') diff --git a/doc/html/qvaluestack.html b/doc/html/qvaluestack.html new file mode 100644 index 0000000..baf86a2 --- /dev/null +++ b/doc/html/qvaluestack.html @@ -0,0 +1,158 @@ + + + + + +QValueStack Class + + + + + + + +

QValueStack Class Reference

+ +

The QValueStack class is a value-based template class that provides a stack. +More... +

All the functions in this class are reentrant when Qt is built with thread support.

#include <qvaluestack.h> +

Inherits QValueList<T>. +

List of all member functions. +

Public Members

QValueStack ()
~QValueStack ()
void push ( const T & d )
T pop ()
T & top ()
const T & top () const

Detailed 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::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. +

Member Function Documentation

QValueStack::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. +

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(). +

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(). + + +

+ +

Trademarks +

Qt 3.3.8

+ -- cgit v1.2.1