diff options
Diffstat (limited to 'doc/man/man3/qptrcollection.3qt')
| -rw-r--r-- | doc/man/man3/qptrcollection.3qt | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/doc/man/man3/qptrcollection.3qt b/doc/man/man3/qptrcollection.3qt new file mode 100644 index 000000000..cf2f93e59 --- /dev/null +++ b/doc/man/man3/qptrcollection.3qt @@ -0,0 +1,145 @@ +'\" t +.TH QPtrCollection 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the +.\" license file included in the distribution for a complete license +.\" statement. +.\" +.ad l +.nh +.SH NAME +QPtrCollection \- The base class of most pointer-based Qt collections +.SH SYNOPSIS +All the functions in this class are reentrant when Qt is built with thread support.</p> +.PP +\fC#include <qptrcollection.h>\fR +.PP +Inherited by QAsciiCache, QAsciiDict, QCache, QDict, QIntCache, QIntDict, QPtrList, QPtrDict, and QPtrVector. +.PP +.SS "Public Members" +.in +1c +.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 = 0" +.br +.ti -1c +.BI "virtual void \fBclear\fR () = 0" +.br +.ti -1c +.BI "typedef void * \fBItem\fR" +.br +.in -1c +.SS "Protected Members" +.in +1c +.ti -1c +.BI "\fBQPtrCollection\fR ()" +.br +.ti -1c +.BI "\fBQPtrCollection\fR ( const QPtrCollection & source )" +.br +.ti -1c +.BI "virtual \fB~QPtrCollection\fR ()" +.br +.ti -1c +.BI "virtual Item \fBnewItem\fR ( Item d )" +.br +.ti -1c +.BI "virtual void \fBdeleteItem\fR ( Item d ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QPtrCollection class is the base class of most pointer-based Qt collections. +.PP +The QPtrCollection class is an abstract base class for the Qt collection classes QDict, QPtrList, etc. Qt also includes value based collections, e.g. QValueList, QMap, etc. +.PP +A QPtrCollection only knows about the number of objects in the collection and the deletion strategy (see setAutoDelete()). +.PP +A collection is implemented using the Item (generic collection item) type, which is a \fCvoid*\fR. The template classes that create the real collections cast the Item to the retquired type. +.PP +See also Collection Classes and Non-GUI Classes. +.SS "Member Type Documentation" +.SH "QPtrCollection::Item" +This type is the generic "item" in a QPtrCollection. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPtrCollection::QPtrCollection ()\fC [protected]\fR" +Constructs a collection. The constructor is protected because QPtrCollection is an abstract class. +.SH "QPtrCollection::QPtrCollection ( const QPtrCollection & source )\fC [protected]\fR" +Constructs a copy of \fIsource\fR with autoDelete() set to FALSE. The constructor is protected because QPtrCollection is an abstract class. +.PP +Note that if \fIsource\fR has autoDelete turned on, copying it will risk memory leaks, reading freed memory, or both. +.SH "QPtrCollection::~QPtrCollection ()\fC [virtual protected]\fR" +Destroys the collection. The destructor is protected because QPtrCollection is an abstract class. +.SH "bool QPtrCollection::autoDelete () const" +Returns the setting of the auto-delete option. The default is FALSE. +.PP +See also setAutoDelete(). +.SH "void QPtrCollection::clear ()\fC [pure virtual]\fR" +Removes all objects from the collection. The objects will be deleted if auto-delete has been enabled. +.PP +See also setAutoDelete(). +.PP +Reimplemented in QAsciiCache, QAsciiDict, QCache, QDict, QIntCache, QIntDict, QPtrList, QPtrDict, and QPtrVector. +.SH "uint QPtrCollection::count () const\fC [pure virtual]\fR" +Returns the number of objects in the collection. +.PP +Reimplemented in QAsciiCache, QAsciiDict, QCache, QDict, QIntCache, QIntDict, QPtrList, QPtrDict, and QPtrVector. +.SH "void QPtrCollection::deleteItem ( Item d )\fC [pure virtual protected]\fR" +Reimplement this function if you want to be able to delete items. +.PP +Deletes an item that is about to be removed from the collection. +.PP +This function has to reimplemented in the collection template classes, and should \fIonly\fR delete item \fId\fR if auto-delete has been enabled. +.PP +\fBWarning:\fR If you reimplement this function you must also reimplement the destructor and call the virtual function clear() from your destructor. This is due to the way virtual functions and destructors work in C++: Virtual functions in derived classes cannot be called from a destructor. If you do not do this, your deleteItem() function will not be called when the container is destroyed. +.PP +See also newItem() and setAutoDelete(). +.SH "Item QPtrCollection::newItem ( Item d )\fC [virtual protected]\fR" +Virtual function that creates a copy of an object that is about to be inserted into the collection. +.PP +The default implementation returns the \fId\fR pointer, i.e. no copy is made. +.PP +This function is seldom reimplemented in the collection template classes. It is not common practice to make a copy of something that is being inserted. +.PP +See also deleteItem(). +.SH "void QPtrCollection::setAutoDelete ( bool enable )" +Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. +.PP +If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. +.PP +The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. +.PP +Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. +.PP +See also autoDelete(). +.PP +Examples: +.)l grapher/grapher.cpp, scribble/scribble.cpp, and table/bigtable/main.cpp. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qptrcollection.html +.BR http://www.trolltech.com/faq/tech.html +.SH COPYRIGHT +Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the +license file included in the distribution for a complete license +statement. +.SH AUTHOR +Generated automatically from the source code. +.SH BUGS +If you find a bug in Qt, please report it as described in +.BR http://doc.trolltech.com/bughowto.html . +Good bug reports help us to help you. Thank you. +.P +The definitive Qt documentation is provided in HTML format; it is +located at $QTDIR/doc/html and can be read using Qt Assistant or with +a web browser. This man page is provided as a convenience for those +users who prefer man pages, although this format is not officially +supported by Trolltech. +.P +If you find errors in this manual page, please report them to +.BR qt-bugs@trolltech.com . +Please include the name of the manual page (qptrcollection.3qt) and the Qt +version (3.3.8). |