QAsciiCacheIterator(3qt)												  QAsciiCacheIterator(3qt)

NAME

       QAsciiCacheIterator - Iterator for QAsciiCache collections

SYNOPSIS

       #include <qasciicache.h>

   Public Members
       QAsciiCacheIterator ( const QAsciiCache<type> & cache )
       QAsciiCacheIterator ( const QAsciiCacheIterator<type> & ci )
       QAsciiCacheIterator<type> & operator= ( const QAsciiCacheIterator<type> & ci )
       uint count () const
       bool isEmpty () const
       bool atFirst () const
       bool atLast () const
       type * toFirst ()
       type * toLast ()
       operator type * () const
       type * current () const
       const char * currentKey () const
       type * operator() ()
       type * operator++ ()
       type * operator+= ( uint jump )
       type * operator-- ()
       type * operator-= ( uint jump )

DESCRIPTION

       The QAsciiCacheIterator class provides an iterator for QAsciiCache collections.

       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.

       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.

       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.

       Note that atFirst() and atLast() refer to the iterator's arbitrary ordering, not to the cache's internal least recently used list.

       See also QAsciiCache, Collection Classes, and Non-GUI Classes.

MEMBER FUNCTION DOCUMENTATION

QAsciiCacheIterator::QAsciiCacheIterator ( const QAsciiCache<type> & cache )
       Constructs an iterator for cache. The current iterator item is set to point to the first item in the cache.

QAsciiCacheIterator::QAsciiCacheIterator ( const QAsciiCacheIterator<type> & ci )
       Constructs an iterator for the same cache as ci. The new iterator starts at the same item as ci.current() but moves independently from
       there on.

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.

       See also toFirst() and atLast().

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.

       See also toLast() and atFirst().

uint QAsciiCacheIterator::count () const
       Returns the number of items in the cache over which this iterator operates.

       See also isEmpty().

type * QAsciiCacheIterator::current () const
       Returns a pointer to the current iterator item.

const char * QAsciiCacheIterator::currentKey () const
       Returns the key for the current iterator item.

bool QAsciiCacheIterator::isEmpty () const
       Returns TRUE if the cache is empty, i.e. count() == 0; otherwise returns FALSE.

       See also count().

QAsciiCacheIterator::operator type * () const
       Cast operator. Returns a pointer to the current iterator item. Same as current().

type * QAsciiCacheIterator::operator() ()
       Makes the succeeding item current and returns the original current item.

       If the current iterator item was the last item in the cache or if it was 0, 0 is returned.

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.

type * QAsciiCacheIterator::operator+= ( uint jump )
       Returns the item jump positions after the current item, or 0 if it is beyond the last item. Makes this the current item.

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.

type * QAsciiCacheIterator::operator-= ( uint jump )
       Returns the item jump positions before the current item, or 0 if it is before the first item. Makes this the current item.

QAsciiCacheIterator<;type> & QAsciiCacheIterator::operator= ( const QAsciiCacheIterator<type> & ci )
       Makes this an iterator for the same cache as ci. The new iterator starts at the same item as ci.current(), but moves independently
       thereafter.

type * QAsciiCacheIterator::toFirst ()
       Sets the iterator to point to the first item in the cache and returns a pointer to the item.

       Sets the iterator to 0 and returns 0 if the cache is empty.

       See also toLast() and isEmpty().

type * QAsciiCacheIterator::toLast ()
       Sets the iterator to point to the last item in the cache and returns a pointer to the item.

       Sets the iterator to 0 and returns 0 if the cache is empty.

       See also isEmpty().

SEE ALSO

       http://doc.trolltech.com/qasciicacheiterator.html http://www.trolltech.com/faq/tech.html

COPYRIGHT

       Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the license file included in the distribution for a complete license
       statement.

AUTHOR

       Generated automatically from the source code.

BUGS

       If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html.  Good bug reports help us to help you.
       Thank you.

       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.

       If you find errors in this manual page, please report them to qt-bugs@trolltech.com.  Please include the name of the manual page
       (qasciicacheiterator.3qt) and the Qt version (3.3.8).

Trolltech AS							  2 February 2007					  QAsciiCacheIterator(3qt)