qqueue.3qt

tmark1.11:用于生成QT/EMBEDDED应用工程的Markfile文件

.TH QQueue 3qt "6 July 1999" "Troll Tech AS" \" -*- nroff -*-
.\" Copyright 1992-1999 Troll Tech AS.  All rights reserved.  See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
QQueue \- Template class that provides a queue
.SH SYNOPSIS
.br
.PP
\fC#include <qqueue.h>\fR
.PP
Inherits QGList.
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "\fBQQueue\fR ()"
.br
.ti -1c
.BI "\fBQQueue\fR ( const QQueue<type> & queue )"
.br
.ti -1c
.BI "\fB~QQueue\fR ()"
.br
.ti -1c
.BI "QQueue<type>& \fBoperator=\fR ( const QQueue<type> & queue )"
.br
.ti -1c
.BI "bool \fBautoDelete\fR () const"
.br
.ti -1c
.BI "void \fBsetAutoDelete\fR ( bool enable )"
.br
.ti -1c
.BI "virtual uint \fBcount\fR () const"
.br
.ti -1c
.BI "bool \fBisEmpty\fR () const"
.br
.ti -1c
.BI "void \fBenqueue\fR ( const type * d )"
.br
.ti -1c
.BI "type* \fBdequeue\fR ()"
.br
.ti -1c
.BI "bool \fBremove\fR ()"
.br
.ti -1c
.BI "virtual void \fBclear\fR ()"
.br
.ti -1c
.BI "type* \fBhead\fR () const"
.br
.ti -1c
.BI "operator \fBtype*\fR ()const"
.br
.ti -1c
.BI "type* \fBcurrent\fR () const"
.br
.in -1c
.SH DESCRIPTION
The QQueue class is a template class that provides a queue.
.PP
QQueue is implemented as a template class. Define a template instance QQueue<X> to create a queue that operates on pointers to X, or X*.
.PP
A queue is a First In, First Out (FIFO) structure. Items are added to the back of the queue with enqueue() and retrieved from the front with dequeue().
.PP
See also: Collection Classes
.SH MEMBER FUNCTION DOCUMENTATION
.SH "QQueue::QQueue ()"
Creates an empty queue.
.SH "QQueue::QQueue ( const QQueue<type> & queue )"
Creates a queue from another.
.PP
Only the pointers are copied (shallow copy).
.SH "QQueue::~QQueue ()"
Destroys the list. Items in the list are destroyed if autoDelete() is TRUE.
.SH "QQueue::operator type* () const"
Returns a reference to the front item in the queue. The queue is not changed.
.SH "type* QQueue::current () const"
Returns a reference to the front item in the queue. The queue is not changed.
.SH "type* QQueue::dequeue ()"
Takes the front item from the queue. First in, first out.
.SH "void QQueue::enqueue ( const type * d )"
Adds an item to the back of the queue. First in, first out.
.SH "type* QQueue::head () const"
Returns a reference to the front item in the queue. The queue is not changed.
.SH "bool QQueue::isEmpty () const"
Returns TRUE if there are no items to be dequeued
.SH "QQueue<type>& QQueue::operator= ( const QQueue<type> & queue )"
Assigns \fIqueue\fR to this queue and returns a reference to this queue.
.PP
This queue is first cleared, then each item in \fIqueue\fR is enqueued to this queue. Only the pointers are copied (shallow copy).
.SH "bool QQueue::remove ()"
Removes the front item from the queue.  First in, first out.
The item is deleted if autoDelete() is TRUE.
Returns TRUE if there was an item to remove.
.SH "SEE ALSO"
.BR http://www.troll.no/qt/qqueue.html
.SH COPYRIGHT
Copyright 1992-1999 Troll Tech AS.  See the license file included in
the distribution for a complete license statement.
.SH AUTHOR
Generated automatically from the source code.