TQIntDictIterator Class Reference

The TQIntDictIterator class provides an iterator for TQIntDict collections. More...

#include <tqintdict.h>

List of all member functions.

Public Members

TQIntDictIterator ( const TQIntDict<type> & dict )
~TQIntDictIterator ()
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 )

Detailed Description

The TQIntDictIterator class provides an iterator for TQIntDict collections.

TQIntDictIterator is implemented as a template class. Define a template instance TQIntDictIterator<X> to create a dictionary iterator that operates on TQIntDict<X> (dictionary of X*).

Example:

    TQIntDict<TQLineEdit> fields;
    for ( int i = 0; i < 3; i++ )
        fields.insert( i, new TQLineEdit( this ) );

    fields[0]->setText( "Homer" );
    fields[1]->setText( "Simpson" );
    fields[2]->setText( "45" );

    TQIntDictIterator<TQLineEdit> it( fields ); 
    for ( ; it.current(); ++it )
        cout << it.currentKey() << ": " << it.current()->text() << endl;

    // Output (random order):
    //  0: Homer
    //  1: Simpson
    //  2: 45

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

Multiple iterators may independently traverse the same dictionary. A TQIntDict knows about all the iterators that are operating on the dictionary. When an item is removed from the dictionary, TQIntDict updates all iterators that refer the removed item to point to the next item in the traversal order.

Member Function Documentation

TQIntDictIterator::TQIntDictIterator ( const TQIntDict<type> & dict )

Constructs an iterator for dict. The current iterator item is set to point to the 'first' item in the dict. The first item refers to the first item in the dictionary's arbitrary internal ordering.

TQIntDictIterator::~TQIntDictIterator ()

Destroys the iterator.

uint TQIntDictIterator::count () const

Returns the number of items in the dictionary this iterator operates over.

type * TQIntDictIterator::current () const

Returns a pointer to the current iterator item.

long TQIntDictIterator::currentKey () const

Returns the key for the current iterator item.

bool TQIntDictIterator::isEmpty () const

Returns TRUE if the dictionary is empty; otherwise eturns FALSE.

TQIntDictIterator::operator type * () const

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

type * TQIntDictIterator::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 0, 0 is returned.

type * TQIntDictIterator::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 0, 0 is returned.

type * TQIntDictIterator::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 0 and returns 0.

type * TQIntDictIterator::toFirst ()

Sets the current iterator item to point to the first item in the dictionary and returns a pointer to the item. The first item refers to the first item in the dictionary's arbitrary internal ordering. If the dictionary is empty it sets the current item to 0 and returns 0.

Trademarks

TQt 3.3.8