src/corelib/tools/qstack.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtCore module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 /*!
  43     \class QStack
  44     \brief The QStack class is a template class that provides a stack.
  45
  46     \ingroup tools
  47     \ingroup shared
  48
  49     \reentrant
  50
  51     QStack\<T\> is one of Qt's generic \l{container classes}. It implements
  52     a stack data structure for items of a same type.
  53
  54     A stack is a last in, first out (LIFO) structure. Items are added
  55     to the top of the stack using push() and retrieved from the top
  56     using pop(). The top() function provides access to the topmost
  57     item without removing it.
  58
  59     Example:
  60
  61     \snippet doc/src/snippets/qstack/main.cpp 0
  62
  63     The example will output 3, 2, 1 in that order.
  64
  65     QStack inherits from QVector. All of QVector's functionality also
  66     applies to QStack. For example, you can use isEmpty() to test
  67     whether the stack is empty, and you can traverse a QStack using
  68     QVector's iterator classes (for example, QVectorIterator). But in
  69     addition, QStack provides three convenience functions that make
  70     it easy to implement LIFO semantics: push(), pop(), and top().
  71
  72     QStack's value type must be an \l{assignable data type}. This
  73     covers most data types that are commonly used, but the compiler
  74     won't let you, for example, store a QWidget as a value; instead,
  75     store a QWidget *.
  76
  77     \sa QVector, QQueue
  78 */
  79
  80 /*!
  81     \fn QStack::QStack()
  82
  83     Constructs an empty stack.
  84 */
  85
  86 /*!
  87     \fn QStack::~QStack()
  88
  89     Destroys the stack. References to the values in the stack, and all
  90     iterators over this stack, become invalid.
  91 */
  92
  93 /*!
  94     \fn void QStack::swap(QStack<T> &other)
  95     \since 4.8
  96
  97     Swaps stack \a other with this stack. This operation is very fast and
  98     never fails.
  99 */
 100
 101 /*!
 102     \fn void QStack::push(const T& t)
 103
 104     Adds element \a t to the top of the stack.
 105
 106     This is the same as QVector::append().
 107
 108     \sa pop(), top()
 109 */
 110
 111 /*!
 112     \fn T& QStack::top()
 113
 114     Returns a reference to the stack's top item. This function
 115     assumes that the stack isn't empty.
 116
 117     This is the same as QVector::last().
 118
 119     \sa pop(), push(), isEmpty()
 120 */
 121
 122 /*!
 123     \fn const T& QStack::top() const
 124
 125     \overload
 126
 127     \sa pop(), push()
 128 */
 129
 130 /*!
 131     \fn T QStack::pop()
 132
 133     Removes the top item from the stack and returns it. This function
 134     assumes that the stack isn't empty.
 135
 136     \sa top(), push(), isEmpty()
 137 */