QIntDictIterator(3qt)

NAME
QIntDictIterator - Iterator for QIntDict collections

SYNOPSIS

#include <qintdict.h>

Inherits QGDictIterator.

  Public Members
QIntDictIterator ( const QIntDict<type> & dict )
~QIntDictIterator ()
uint count () const
bool isEmpty () const
type* toFirst ()
operator type* ()const
type* current () const
long currentKey () const
type* operator ()
type* operator++ ()
type* operator+= ( uint jump )

DESCRIPTION
The QIntDictIterator class provides an iterator for QIntDict collections.

QIntDictIterator is implemented as both a template and a macro class. Define a template instance QIntDictIterator<X> to create a dictionary iterator that operates on QIntDict<X> (dictionary of X*).

Example:

    #include <qintdict.h>
    #include <stdio.h>
    void main()
    {
        QIntDict<char> dict;            // maps long ==> char*
        dict.insert( 33, "France" );
        dict.insert(  7, "Russia" );
        dict.insert( 49, "Norway" );
        QIntDictIterator<char> it( dict ); // iterator for dict
        while ( it.current() ) {
            printf( "%d -> %s\n", it.currentKey(), it.current() );
            ++it;
        }
    }

Program output:

        7 -> Russia
        49 -> Norway
        33 -> France

Note that the traversal order is arbitrary, you are not guaranteed the order above.

A QIntDictIterator can also be instantiated through a macro expansion, but this is necessary only for compilers that do not support templates. See the collection classes documentation for a general discussion on template-based versus macro-based collections.

Multiple iterators may independently traverse the same dictionary. A QIntDict knows about all iterators that are operating on the dictionary. When an item is removed from the dictionary, QIntDict update all iterators that are referring the removed item to point to the next item in the traversing order.

See also: QIntDict and Collection Classes

MEMBER FUNCTION DOCUMENTATION

QIntDictIterator::QIntDictIterator ( const QIntDict<type> & dict )
Constructs an iterator for dict. The current iterator item is set to point on the first item in the dict.

QIntDictIterator::~QIntDictIterator ()
Destroys the iterator.

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

uint QIntDictIterator::count () const
Returns the number of items in the dictionary this iterator operates on.

See also: isEmpty().

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

long QIntDictIterator::currentKey () const
Returns the key for the current iterator item.

bool QIntDictIterator::isEmpty () const
Returns TRUE if the dictionary is empty, i.e. count() == 0. Returns FALSE otherwise.

See also: count().

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

If the current iterator item was the last item in the dictionary or if it was null, null is returned.

type * QIntDictIterator::operator++ ()
Prefix ++ makes the succeeding item current and returns the new current item.

If the current iterator item was the last item in the dictionary or if it was null, null is returned.

type * QIntDictIterator::operator+= ( uint jump )
Sets the current item to the item jump positions after the current item, and returns a pointer to that item.

If that item is beyond the last item or if the dictionary is empty, it sets the current item to null and returns null.

type * QIntDictIterator::toFirst ()
Sets the current iterator item to point to the first item in the dictionary and returns a pointer to the item. If the dictionary is empty it sets the current item to null and returns null.

SEE ALSO
http://www.troll.no/qt/qintdictiterator.html

COPYRIGHT
Copyright 1992-1997 Troll Tech AS. See the LICENSE file included in the distribution for a complete license statement.

AUTHOR
Generated automatically from the source code.