diff options
Diffstat (limited to 'doc/man/man3/qasciicacheiterator.3qt')
| -rw-r--r-- | doc/man/man3/qasciicacheiterator.3qt | 157 |
1 files changed, 157 insertions, 0 deletions
diff --git a/doc/man/man3/qasciicacheiterator.3qt b/doc/man/man3/qasciicacheiterator.3qt new file mode 100644 index 000000000..b8fe06c08 --- /dev/null +++ b/doc/man/man3/qasciicacheiterator.3qt @@ -0,0 +1,157 @@ +'\" t +.TH QAsciiCacheIterator 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 +QAsciiCacheIterator \- Iterator for QAsciiCache collections +.SH SYNOPSIS +\fC#include <qasciicache.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQAsciiCacheIterator\fR ( const QAsciiCache<type> & cache )" +.br +.ti -1c +.BI "\fBQAsciiCacheIterator\fR ( const QAsciiCacheIterator<type> & ci )" +.br +.ti -1c +.BI "QAsciiCacheIterator<type> & \fBoperator=\fR ( const QAsciiCacheIterator<type> & ci )" +.br +.ti -1c +.BI "uint \fBcount\fR () const" +.br +.ti -1c +.BI "bool \fBisEmpty\fR () const" +.br +.ti -1c +.BI "bool \fBatFirst\fR () const" +.br +.ti -1c +.BI "bool \fBatLast\fR () const" +.br +.ti -1c +.BI "type * \fBtoFirst\fR ()" +.br +.ti -1c +.BI "type * \fBtoLast\fR ()" +.br +.ti -1c +.BI "\fBoperator type *\fR () const" +.br +.ti -1c +.BI "type * \fBcurrent\fR () const" +.br +.ti -1c +.BI "const char * \fBcurrentKey\fR () const" +.br +.ti -1c +.BI "type * \fBoperator()\fR ()" +.br +.ti -1c +.BI "type * \fBoperator++\fR ()" +.br +.ti -1c +.BI "type * \fBoperator+=\fR ( uint jump )" +.br +.ti -1c +.BI "type * \fBoperator--\fR ()" +.br +.ti -1c +.BI "type * \fBoperator-=\fR ( uint jump )" +.br +.in -1c +.SH DESCRIPTION +The QAsciiCacheIterator class provides an iterator for QAsciiCache collections. +.PP +Note that the traversal order is arbitrary; you are not guaranteed any particular order. If new objects are inserted into the cache while the iterator is active, the iterator may or may not see them. +.PP +Multiple iterators are completely independent, even when they operate on the same QAsciiCache. QAsciiCache updates all iterators that refer an item when that item is removed. +.PP +QAsciiCacheIterator provides an operator++() and an operator+=() to traverse the cache; current() and currentKey() to access the current cache item and its key. It also provides atFirst() and atLast(), which return TRUE if the iterator points to the first or last item in the cache respectively. The isEmpty() function returns TRUE if the cache is empty; and count() returns the number of items in the cache. +.PP +Note that atFirst() and atLast() refer to the iterator's arbitrary ordering, not to the cache's internal least recently used list. +.PP +See also QAsciiCache, Collection Classes, and Non-GUI Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QAsciiCacheIterator::QAsciiCacheIterator ( const QAsciiCache<type> & cache )" +Constructs an iterator for \fIcache\fR. The current iterator item is set to point to the first item in the \fIcache\fR. +.SH "QAsciiCacheIterator::QAsciiCacheIterator ( const QAsciiCacheIterator<type> & ci )" +Constructs an iterator for the same cache as \fIci\fR. The new iterator starts at the same item as ci.current() but moves independently from there on. +.SH "bool QAsciiCacheIterator::atFirst () const" +Returns TRUE if the iterator points to the first item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. +.PP +See also toFirst() and atLast(). +.SH "bool QAsciiCacheIterator::atLast () const" +Returns TRUE if the iterator points to the last item in the cache; otherwise returns FALSE. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. +.PP +See also toLast() and atFirst(). +.SH "uint QAsciiCacheIterator::count () const" +Returns the number of items in the cache over which this iterator operates. +.PP +See also isEmpty(). +.SH "type * QAsciiCacheIterator::current () const" +Returns a pointer to the current iterator item. +.SH "const char * QAsciiCacheIterator::currentKey () const" +Returns the key for the current iterator item. +.SH "bool QAsciiCacheIterator::isEmpty () const" +Returns TRUE if the cache is empty, i.e. count() == 0; otherwise returns FALSE. +.PP +See also count(). +.SH "QAsciiCacheIterator::operator type * () const" +Cast operator. Returns a pointer to the current iterator item. Same as current(). +.SH "type * QAsciiCacheIterator::operator() ()" +Makes the succeeding item current and returns the original current item. +.PP +If the current iterator item was the last item in the cache or if it was 0, 0 is returned. +.SH "type * QAsciiCacheIterator::operator++ ()" +Prefix ++ makes the iterator point to the item just after current(), and makes that the new current item for the iterator. If current() was the last item, operator++() returns 0. +.SH "type * QAsciiCacheIterator::operator+= ( uint jump )" +Returns the item \fIjump\fR positions after the current item, or 0 if it is beyond the last item. Makes this the current item. +.SH "type * QAsciiCacheIterator::operator-- ()" +Prefix -- makes the iterator point to the item just before current(), and makes that the new current item for the iterator. If current() was the first item, operator--() returns 0. +.SH "type * QAsciiCacheIterator::operator-= ( uint jump )" +Returns the item \fIjump\fR positions before the current item, or 0 if it is before the first item. Makes this the current item. +.SH "QAsciiCacheIterator<type> & QAsciiCacheIterator::operator= ( const QAsciiCacheIterator<type> & ci )" +Makes this an iterator for the same cache as \fIci\fR. The new iterator starts at the same item as ci.current(), but moves independently thereafter. +.SH "type * QAsciiCacheIterator::toFirst ()" +Sets the iterator to point to the first item in the cache and returns a pointer to the item. +.PP +Sets the iterator to 0 and returns 0 if the cache is empty. +.PP +See also toLast() and isEmpty(). +.SH "type * QAsciiCacheIterator::toLast ()" +Sets the iterator to point to the last item in the cache and returns a pointer to the item. +.PP +Sets the iterator to 0 and returns 0 if the cache is empty. +.PP +See also isEmpty(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qasciicacheiterator.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 (qasciicacheiterator.3qt) and the Qt +version (3.3.8). |