TQPtrDictIterator Class

Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# TQPtrDictIterator Class Reference

The TQPtrDictIterator class provides an iterator for TQPtrDict collections. More...

`#include <ntqptrdict.h>`

List of all member functions.

## Public Members

- TQPtrDictIterator ( const TQPtrDict<type> & dict )
- ~TQPtrDictIterator ()
- uint count () const
- bool isEmpty () const
- type * toFirst ()
- operator type * () const
- type * current () const
- void * currentKey () const
- type * operator() ()
- type * operator++ ()
- type * operator+= ( uint jump )

## Detailed Description

The TQPtrDictIterator class provides an iterator for TQPtrDict collections.

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

Example:

        TQPtrDict<char> fields;

        TQLineEdit *le1 = new TQLineEdit( this );
        le1->setText( "Simpson" );
        TQLineEdit *le2 = new TQLineEdit( this );
        le2->setText( "Homer" );
        TQLineEdit *le3 = new TQLineEdit( this );
        le3->setText( "45" );

        fields.insert( le1, "Surname" );
        fields.insert( le2, "Forename" );
        fields.insert( le3, "Age" );

        TQPtrDictIterator<char> it( fields );
        for( ; it.current(); ++it ) {
            TQLineEdit *le = (TQLineEdit)it.currentKey();
            cout << it.current() << ": " << le->text() << endl;
        }
        cout << endl;

        // Output (random order):
        //  Forename: Homer
        //  Age: 45
        //  Surname: Simpson

In the example we insert some line edits into a dictionary, associating a string with each. We then iterate over the dictionary printing the associated strings.

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

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

## Member Function Documentation

### TQPtrDictIterator::TQPtrDictIterator ( const TQPtrDict<type> & dict )

Constructs an iterator for dict. The current iterator item is set to point on the first item in the dict.

### TQPtrDictIterator::~TQPtrDictIterator ()

Destroys the iterator.

### uint TQPtrDictIterator::count () const

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

See also isEmpty().

### type * TQPtrDictIterator::current () const

Returns a pointer to the current iterator item's value.

### void * TQPtrDictIterator::currentKey () const

Returns the current iterator item's key.

### bool TQPtrDictIterator::isEmpty () const

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

See also count().

### TQPtrDictIterator::operator type * () const

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

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

This file is part of the TQt toolkit. Copyright © 1995-2007 Trolltech. All Rights Reserved.