Contents

• Public Functions
• Detailed Description

Detailed Description

TheQ3AsciiCacheIterator class provides an iterator forQ3AsciiCache 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 sameQ3AsciiCache.Q3AsciiCache updates all iterators that refer an item when that item is removed.

Q3AsciiCacheIterator provides an operator++() and an operator+=() to traverse the cache;current() andcurrentKey() to access the current cache item and its key. It also providesatFirst() andatLast(), which return TRUE if the iterator points to the first or last item in the cache respectively. TheisEmpty() function returns TRUE if the cache is empty; andcount() returns the number of items in the cache.

Note thatatFirst() andatLast() refer to the iterator's arbitrary ordering, not to the cache's internal least recently used list.

Member Function Documentation

Q3AsciiCacheIterator::Q3AsciiCacheIterator(constQ3AsciiCache<type> & cache)

Constructs an iterator forcache. The current iterator item is set to point to the first item in thecache.

Q3AsciiCacheIterator::Q3AsciiCacheIterator(constQ3AsciiCacheIterator<type> & ci)

Constructs an iterator for the same cache asci. The new iterator starts at the same item as ci.current() but moves independently from there on.

bool Q3AsciiCacheIterator::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 alsotoFirst() andatLast().

bool Q3AsciiCacheIterator::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 alsotoLast() andatFirst().

uint Q3AsciiCacheIterator::count() const

Returns the number of items in the cache over which this iterator operates.

See alsoisEmpty().

type * Q3AsciiCacheIterator::current() const

Returns a pointer to the current iterator item.

constchar * Q3AsciiCacheIterator::currentKey() const

Returns the key for the current iterator item.

bool Q3AsciiCacheIterator::isEmpty() const

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

See alsocount().

type * Q3AsciiCacheIterator::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 alsotoLast() andisEmpty().

type * Q3AsciiCacheIterator::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 alsotoFirst() andisEmpty().

Q3AsciiCacheIterator::operator type *() const

Cast operator. Returns a pointer to the current iterator item. Same ascurrent().

type * Q3AsciiCacheIterator::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 * Q3AsciiCacheIterator::operator++()

Prefix ++ makes the iterator point to the item just aftercurrent(), and makes that the new current item for the iterator. Ifcurrent() was the last item, operator++() returns 0.

type * Q3AsciiCacheIterator::operator+=(uint jump)

Returns the itemjump positions after the current item, or 0 if it is beyond the last item. Makes this the current item.

type * Q3AsciiCacheIterator::operator--()

Prefix -- makes the iterator point to the item just beforecurrent(), and makes that the new current item for the iterator. Ifcurrent() was the first item, operator--() returns 0.

type * Q3AsciiCacheIterator::operator-=(uint jump)

Returns the itemjump positions before the current item, or 0 if it is before the first item. Makes this the current item.

Q3AsciiCacheIterator<type> & Q3AsciiCacheIterator::operator=(constQ3AsciiCacheIterator<type> & ci)

Makes this an iterator for the same cache asci. The new iterator starts at the same item as ci.current(), but moves independently thereafter.