Contents

• Public Types
• Public Functions
• Detailed Description

Detailed Description

TheQMap::const_iterator class provides an STL-style const iterator forQMap andQMultiMap.

QMap features bothSTL-style iterators andJava-style iterators. The STL-style iterators are more low-level and more cumbersome to use; on the other hand, they are slightly faster and, for developers who already know STL, have the advantage of familiarity.

QMap<Key, T>::const_iterator allows you to iterate over aQMap (or aQMultiMap). If you want to modify theQMap as you iterate over it, you must useQMap::iterator instead. It is generally good practice to useQMap::const_iterator on a non-constQMap as well, unless you need to change theQMap through the iterator. Const iterators are slightly faster, and can improve code readability.

The defaultQMap::const_iterator constructor creates an uninitialized iterator. You must initialize it using aQMap function likeQMap::constBegin(),QMap::constEnd(), orQMap::find() before you can start iterating. Here's a typical loop that prints all the (key, value) pairs stored in a map:

QMap<QString,int> map;map.insert("January",1);map.insert("February",2);...map.insert("December",12);QMap<QString,int>::const_iterator i;for (i= map.constBegin(); i!= map.constEnd();++i)    cout<< i.key()<<": "<< i.value()<< endl;

UnlikeQHash, which stores its items in an arbitrary order,QMap stores its items ordered by key. Items that share the same key (because they were inserted usingQMap::insertMulti()) will appear consecutively, from the most recently to the least recently inserted value.

Multiple iterators can be used on the same map. If you add items to the map, existing iterators will remain valid. If you remove items from the map, iterators that point to the removed items will become dangling iterators.

Member Type Documentation

typedef const_iterator::iterator_category

A synonym forstd::bidirectional_iterator_tag indicating this iterator is a bidirectional iterator.

Member Function Documentation

const_iterator::const_iterator()

Constructs an uninitialized iterator.

Functions likekey(),value(), and operator++() must not be called on an uninitialized iterator. Use operator=() to assign a value to it before using it.

See alsoQMap::constBegin() andQMap::constEnd().

const_iterator::const_iterator(constiterator & other)

Constructs a copy ofother.

constKey & const_iterator::key() const

Returns the current item's key.

See alsovalue().

constT & const_iterator::value() const

Returns the current item's value.

See alsokey() andoperator*().

bool const_iterator::operator!=(constconst_iterator & other) const

Returns true ifother points to a different item than this iterator; otherwise returns false.

See alsooperator==().

constT & const_iterator::operator*() const

Returns the current item's value.

Same asvalue().

See alsokey().

const_iterator const_iterator::operator+(int j) const

Returns an iterator to the item atj positions forward from this iterator. (Ifj is negative, the iterator goes backward.)

This operation can be slow for largej values.

See alsooperator-().

const_iterator & const_iterator::operator++()

The prefix ++ operator (++i) advances the iterator to the next item in the map and returns an iterator to the new current item.

Calling this function onQMap::end() leads to undefined results.

See alsooperator--().

const_iterator const_iterator::operator++(int)

This is an overloaded function.

The postfix ++ operator (i++) advances the iterator to the next item in the map and returns an iterator to the previously current item.

const_iterator & const_iterator::operator+=(int j)

Advances the iterator byj items. (Ifj is negative, the iterator goes backward.)

This operation can be slow for largej values.

See alsooperator-=() andoperator+().

const_iterator const_iterator::operator-(int j) const

Returns an iterator to the item atj positions backward from this iterator. (Ifj is negative, the iterator goes forward.)

This operation can be slow for largej values.

See alsooperator+().

const_iterator & const_iterator::operator--()

The prefix -- operator (--i) makes the preceding item current and returns an iterator pointing to the new current item.

Calling this function onQMap::begin() leads to undefined results.

See alsooperator++().

const_iterator const_iterator::operator--(int)

This is an overloaded function.

The postfix -- operator (i--) makes the preceding item current and returns an iterator pointing to the previously current item.

const_iterator & const_iterator::operator-=(int j)

Makes the iterator go back byj items. (Ifj is negative, the iterator goes forward.)

This operation can be slow for largej values.

See alsooperator+=() andoperator-().

constT * const_iterator::operator->() const

Returns a pointer to the current item's value.

See alsovalue().

bool const_iterator::operator==(constconst_iterator & other) const

Returns true ifother points to the same item as this iterator; otherwise returns false.

See alsooperator!=().