From d796c9dd933ab96ec83b9a634feedd5d32e1ba3f Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Tue, 8 Nov 2011 12:31:36 -0600 Subject: Test conversion to TQt3 from Qt3 8c6fc1f8e35fd264dd01c582ca5e7549b32ab731 --- doc/html/qptrqueue.html | 216 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 216 insertions(+) create mode 100644 doc/html/qptrqueue.html (limited to 'doc/html/qptrqueue.html') diff --git a/doc/html/qptrqueue.html b/doc/html/qptrqueue.html new file mode 100644 index 000000000..a98474a32 --- /dev/null +++ b/doc/html/qptrqueue.html @@ -0,0 +1,216 @@ + + + + + +TQPtrQueue Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

TQPtrQueue Class Reference

+ +

The TQPtrQueue class is a template class that provides a queue. +More... +

#include <qptrqueue.h> +

List of all member functions. +

Public Members

+ +

Protected Members

+ +

Detailed Description

+ + +The TQPtrQueue class is a template class that provides a queue. +

+ +

TQValueVector can be used as an STL-compatible alternative to this +class. +

A template instance TQPtrQueue<X> is a queue that operates on +pointers to X (X*). +

A queue is a first in, first out structure. Items are added to the +tail of the queue with enqueue() and retrieved from the head with +dequeue(). You can peek at the head item without dequeing it using +head(). +

You can control the queue's deletion policy with setAutoDelete(). +

For compatibility with the TQPtrCollection classes, current() and +remove() are provided; both operate on the head(). +

See also TQPtrList, TQPtrStack, Collection Classes, and Non-GUI Classes. + +

Member Function Documentation

+

TQPtrQueue::TQPtrQueue () +

+ +

Creates an empty queue with autoDelete() set to FALSE. + +

TQPtrQueue::TQPtrQueue ( const TQPtrQueue<type> & queue ) +

+ +

Creates a queue from queue. +

Only the pointers are copied; the items are not. The autoDelete() +flag is set to FALSE. + +

TQPtrQueue::~TQPtrQueue () +

+ +

Destroys the queue. Items in the queue are deleted if autoDelete() +is TRUE. + +

bool TQPtrQueue::autoDelete () const +

+ +

Returns the setting of the auto-delete option. The default is +FALSE. +

See also setAutoDelete(). + +

void TQPtrQueue::clear () +

+ +

Removes all items from the queue, and deletes them if autoDelete() +is TRUE. +

See also remove(). + +

uint TQPtrQueue::count () const +

+ +

Returns the number of items in the queue. +

See also isEmpty(). + +

type * TQPtrQueue::current () const +

+ +

Returns a pointer to the head item in the queue. The queue is not +changed. Returns 0 if the queue is empty. +

See also dequeue() and isEmpty(). + +

type * TQPtrQueue::dequeue () +

+ +

Takes the head item from the queue and returns a pointer to it. +Returns 0 if the queue is empty. +

See also enqueue() and count(). + +

void TQPtrQueue::enqueue ( const type * d ) +

+ +

Adds item d to the tail of the queue. +

See also count() and dequeue(). + +

type * TQPtrQueue::head () const +

+ +

Returns a pointer to the head item in the queue. The queue is not +changed. Returns 0 if the queue is empty. +

See also dequeue() and isEmpty(). + +

bool TQPtrQueue::isEmpty () const +

+ +

Returns TRUE if the queue is empty; otherwise returns FALSE. +

See also count(), dequeue(), and head(). + +

TQPtrQueue::operator type * () const +

+ +

Returns a pointer to the head item in the queue. The queue is not +changed. Returns 0 if the queue is empty. +

See also dequeue() and isEmpty(). + +

TQPtrQueue<type> & TQPtrQueue::operator= ( const TQPtrQueue<type> & queue ) +

+ +

Assigns queue to this queue and returns a reference to this +queue. +

This queue is first cleared and then each item in queue is +enqueued to this queue. Only the pointers are copied. +

Warning: The autoDelete() flag is not modified. If it it TRUE for +both queue and this queue, deleting the two lists will cause double-deletion of the items. + +

TQDataStream & TQPtrQueue::read ( TQDataStream & s, TQPtrCollection::Item & item ) [virtual protected] +

+ +

Reads a queue item, item, from the stream s and returns a +reference to the stream. +

The default implementation sets item to 0. +

See also write(). + +

bool TQPtrQueue::remove () +

+ +

Removes the head item from the queue, and returns TRUE if there +was an item, i.e. the queue wasn't empty; otherwise returns FALSE. +

The item is deleted if autoDelete() is TRUE. +

See also head(), isEmpty(), and dequeue(). + +

void TQPtrQueue::setAutoDelete ( bool enable ) +

+ +

Sets the queue to auto-delete its contents if enable is TRUE +and not to delete them if enable is FALSE. +

If auto-deleting is turned on, all the items in a queue are +deleted when the queue itself is deleted. This can be tquite +convenient if the queue has the only pointer to the items. +

The default setting is FALSE, for safety. If you turn it on, be +careful about copying the queue: you might find yourself with two +queues deleting the same items. +

See also autoDelete(). + +

TQDataStream & TQPtrQueue::write ( TQDataStream & s, TQPtrCollection::Item item ) const [virtual protected] +

+ +

Writes a queue item, item, to the stream s and returns a +reference to the stream. +

The default implementation does nothing. +

See also read(). + + +

+This file is part of the TQt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
TQt 3.3.8
+
+ -- cgit v1.2.1