Contents

• Public Functions
• Detailed Description

Detailed Description

TheQ3AsciiDictIterator class provides an iterator forQ3AsciiDict collections.

Q3AsciiDictIterator is implemented as a template class. Define a template instanceQ3AsciiDictIterator<X> to create a dictionary iterator that operates onQ3AsciiDict<X> (dictionary of X*).

Example:

Q3AsciiDict<QLineEdit> fields;fields.insert("forename",newQLineEdit(this ) );fields.insert("surname",newQLineEdit(this ) );fields.insert("age",newQLineEdit(this ) );fields["forename"]->setText("Homer" );fields["surname"]->setText("Simpson" );fields["age"]->setText("45" );Q3AsciiDictIterator<QLineEdit> it( fields );for( ; it.current();++it )    cout<< it.currentKey()<<": "<< it.current()->text()<< endl;cout<< endl;// Output (random order)://      age: 45//      surname: Simpson//      forename: Homer

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

Note that the traversal order is arbitrary; you are not guaranteed any particular order.

Multiple iterators may independently traverse the same dictionary. AQ3AsciiDict knows about all the iterators that are operating on the dictionary. When an item is removed from the dictionary,Q3AsciiDict updates all the iterators that are referring to the removed item to point to the next item in the (arbitrary) traversal order.

Member Function Documentation

Q3AsciiDictIterator::Q3AsciiDictIterator(constQ3AsciiDict<type> & dict)

Constructs an iterator fordict. The current iterator item is set to point on the first item in thedict.

Q3AsciiDictIterator::~Q3AsciiDictIterator()

Destroys the iterator.

uint Q3AsciiDictIterator::count() const

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

See alsoisEmpty().

type * Q3AsciiDictIterator::current() const

Returns a pointer to the current iterator item.

constchar * Q3AsciiDictIterator::currentKey() const

Returns a pointer to the key for the current iterator item.

bool Q3AsciiDictIterator::isEmpty() const

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

See alsocount().

type * Q3AsciiDictIterator::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.

Q3AsciiDictIterator::operator type *() const

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

type * Q3AsciiDictIterator::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 * Q3AsciiDictIterator::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 * Q3AsciiDictIterator::operator+=(uint jump)

Sets the current item to the itemjump 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.