~oif-team/ubuntu/natty/qt4-x11/xi2.1

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="annotated.html"><font color="#004faf">Annotated</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>

<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QStack Class Reference</h1>

<p>The QStack class is a template class that provides a stack. <a href="#details">More...</a></p>

<pre>#include <QStack></pre><p>Part of the <a href="qtcore.html">QtCore</a> module.</p>

<p>Inherits <a href="qvector.html">QVector<T></a>.</p>

<p><b>Note:</b> All the functions in this class are <a href="threads.html#reentrant">reentrant</a>.</p>

<ul>

<li><a href="qstack-members.html">List of all members, including inherited members</a></li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="qstack.html#QStack">QStack</a></b> ()</li>

<li><div class="fn"/><b><a href="qstack.html#dtor.QStack">~QStack</a></b> ()</li>

<li><div class="fn"/>void <b><a href="qstack.html#push">push</a></b> ( const T & <i>t</i> )</li>

<li><div class="fn"/>const T & <b><a href="qstack.html#top-2">top</a></b> () const</li>

</ul>

<ul>

<li><div class="fn"/>62 public functions inherited from <a href="qvector.html#public-functions">QVector</a></li>

</ul>

<h3>Additional Inherited Members</h3>

<ul>

<li><div class="fn"/>2 static public members inherited from <a href="qvector.html#static-public-members">QVector</a></li>

</ul>

<hr />

<h2>Detailed Description</h2>

<p>The QStack class is a template class that provides a stack.</p>

<p>QStack<T> is one of Qt's generic <a href="containers.html#container-classes">container classes</a>. It implements a stack data structure for items of a same type.</p>

<p>A stack is a last in, first out (LIFO) structure. Items are added to the top of the stack using <a href="qstack.html#push">push</a>() and retrieved from the top using <a href="qstack.html#pop">pop</a>(). The <a href="qstack.html#top">top</a>() function provides access to the topmost item without removing it.</p>

<p>Example:</p>

<pre>  QStack<int> stack;

stack.push(1);

stack.push(2);

stack.push(3);

while (!stack.isEmpty())

cout << stack.pop() << endl;</pre>

<p>The example will output 3, 2, 1 in that order.</p>

<p>QStack inherits from <a href="qvector.html">QVector</a>. All of <a href="qvector.html">QVector</a>'s functionality also applies to QStack. For example, you can use <a href="qvector.html#isEmpty">isEmpty</a>() to test whether the stack is empty, and you can traverse a QStack using <a href="qvector.html">QVector</a>'s iterator classes (for example, <a href="qvectoriterator.html">QVectorIterator</a>). But in addition, QStack provides three convenience functions that make it easy to implement LIFO semantics: <a href="qstack.html#push">push</a>(), <a href="qstack.html#pop">pop</a>(), and <a href="qstack.html#top">top</a>().</p>

<p>QStack's value type must be an <a href="containers.html#assignable-data-types">assignable data type</a>. This covers most data types that are commonly used, but the compiler won't let you, for example, store a <a href="qwidget.html">QWidget</a> as a value; instead, store a <a href="qwidget.html">QWidget</a> *.</p>

<p>See also <a href="qvector.html">QVector</a> and <a href="qqueue.html">QQueue</a>.</p>

<hr />

<h2>Member Function Documentation</h2>

<h3 class="fn"><a name="QStack"></a>QStack::QStack ()</h3>

<p>Constructs an empty stack.</p>

<h3 class="fn"><a name="dtor.QStack"></a>QStack::~QStack ()</h3>

<p>Destroys the stack. References to the values in the stack, and all iterators over this stack, become invalid.</p>

<h3 class="fn"><a name="pop"></a>T QStack::pop ()</h3>

<p>Removes the top item from the stack and returns it. This function assumes that the stack isn't empty.</p>

<p>See also <a href="qstack.html#top">top</a>(), <a href="qstack.html#push">push</a>(), and <a href="qvector.html#isEmpty">isEmpty</a>().</p>

<h3 class="fn"><a name="push"></a>void QStack::push ( const T & <i>t</i> )</h3>

<p>Adds element <i>t</i> to the top of the stack.</p>

<p>This is the same as <a href="qvector.html#append">QVector::append</a>().</p>

<h3 class="fn"><a name="top"></a>T & QStack::top ()</h3>

<p>Returns a reference to the stack's top item. This function assumes that the stack isn't empty.</p>

<p>This is the same as <a href="qvector.html#last">QVector::last</a>().</p>

<p>See also <a href="qstack.html#pop">pop</a>(), <a href="qstack.html#push">push</a>(), and <a href="qvector.html#isEmpty">isEmpty</a>().</p>

<h3 class="fn"><a name="top-2"></a>const T & QStack::top () const</h3>

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

</tr></table></div></address></body>

</html>

Older »