QQueue< T > Class Template Reference

#include <qqueue.h>

Inheritance diagram for QQueue< T >:

Inheritance graph
[legend]
Collaboration diagram for QQueue< T >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class T>
class QQueue< T >

The QQueue class is a generic container that provides a queue.

QQueue<T> is one of Qt's generic {container classes}. It implements a queue data structure for items of a same type.

A queue is a first in, first out (FIFO) structure. Items are added to the tail of the queue using enqueue() and retrieved from the head using dequeue(). The head() function provides access to the head item without removing it.

Example:

        QQueue<int> queue;
        queue.enqueue(1);
        queue.enqueue(2);
        queue.enqueue(3);
        while (!queue.isEmpty())
            cout << queue.dequeue() << endl;

The example will output 1, 2, 3 in that order.

QQueue inherits from QList. All of QList's functionality also applies to QQueue. For example, you can use isEmpty() to test whether the queue is empty, and you can traverse a QQueue using QList's iterator classes (for example, QListIterator). But in addition, QQueue provides three convenience functions that make it easy to implement FIFO semantics: enqueue(), dequeue(), and head().

QQueue's value type must be an {assignable data type}. This covers most data types that are commonly used, but the compiler won't let you, for example, store a QWidget as a value; instead, store a QWidget *.

See also:
QList, QStack

Definition at line 34 of file qqueue.h.

Public Member Functions

 QQueue ()
 ~QQueue ()
void enqueue (const T &t)
dequeue ()
T & head ()
const T & head () const


Constructor & Destructor Documentation

template<class T>
QQueue< T >::QQueue (  )  [inline]

Constructs an empty queue.

Definition at line 37 of file qqueue.h.

00037 {}

template<class T>
QQueue< T >::~QQueue (  )  [inline]

Destroys the queue. References to the values in the queue, and all iterators over this queue, become invalid.

Definition at line 38 of file qqueue.h.

00038 {}


Member Function Documentation

template<class T>
void QQueue< T >::enqueue ( const T &  t  )  [inline]

Adds value t to the tail of the queue.

This is the same as QList::append().

See also:
dequeue(), head()

Definition at line 39 of file qqueue.h.

Referenced by QSocks5SocketEnginePrivate::_q_udpSocketReadNotification(), Dialog::createRotableGroupBox(), QSvgTinyDocument::draw(), QAbstractFormBuilder::loadTreeWidgetExtraInfo(), qdesigner_internal::TreeWidgetEditor::moveColumnsLeft(), qdesigner_internal::TreeWidgetEditor::moveColumnsRight(), Dialog::rotateWidgets(), and QAbstractFormBuilder::saveTreeWidgetExtraInfo().

00039 { QList<T>::append(t); }

template<class T>
T QQueue< T >::dequeue (  )  [inline]

Removes the head item in the queue and returns it. This function assumes that the queue isn't empty.

This is the same as QList::takeFirst().

See also:
head(), enqueue(), isEmpty()

Definition at line 40 of file qqueue.h.

Referenced by QAbstractFormBuilder::loadTreeWidgetExtraInfo(), qdesigner_internal::TreeWidgetEditor::moveColumnsLeft(), qdesigner_internal::TreeWidgetEditor::moveColumnsRight(), Dialog::rotateWidgets(), and QAbstractFormBuilder::saveTreeWidgetExtraInfo().

00040 { return QList<T>::takeFirst(); }

template<class T>
T & QQueue< T >::head (  )  [inline]

Returns a reference to the queue's head item. This function assumes that the queue isn't empty.

This is the same as QList::first().

See also:
dequeue(), enqueue(), isEmpty()

Definition at line 41 of file qqueue.h.

00041 { return QList<T>::first(); }

template<class T>
const T & QQueue< T >::head (  )  const [inline]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 42 of file qqueue.h.

00042 { return QList<T>::first(); }


The documentation for this class was generated from the following files:
Generated on Thu Mar 15 18:46:29 2007 for Qt 4.2 User's Guide by  doxygen 1.5.1