QMapIterator Class Reference

The QMapIterator class provides an iterator for QMap. More...

#include <qmap.h>

List of all member functions.

Public Members

typedef std::bidirectional_iterator_tag iterator_category
typedef T value_type
typedef T * pointer
typedef T & reference
QMapIterator ()
QMapIterator ( QMapNode<K, T> * p )
QMapIterator ( const QMapIterator<K, T> & it )
bool operator== ( const QMapIterator<K, T> & it ) const
bool operator!= ( const QMapIterator<K, T> & it ) const
T & operator* ()
const T & operator* () const
const K & key () const
T & data ()
const T & data () const
QMapIterator<K, T> & operator++ ()
QMapIterator<K, T> operator++ ( int )
QMapIterator<K, T> & operator-- ()
QMapIterator<K, T> operator-- ( int )

Detailed Description

The QMapIterator class provides an iterator for QMap.

You cannot create an iterator by yourself. Instead, you have to ask a map to give you one. An iterator is as big as a pointer; on 32-bit machines that means 4 bytes, on 64-bit ones 8 bytes. That makes copying them very fast. They resemble the semantics of pointers as much as possible, and they are almost as fast as usual pointers. See the QMap example.

The only way to traverse a map is to use iterators. QMap is highly optimized for performance and memory usage. On the other hand this means that you have to be a bit more careful with what you are doing. QMap does not know about all its iterators, and the iterators don't even know to which map they belong. That makes things fast but a bit dangerous because it is up to you to make sure that the iterators you are using are still valid. QDictIterator will be able to give warnings, whereas QMapIterator may end up in an undefined state.

For every Iterator there is also a ConstIterator. You have to use the ConstIterator to access a QMap in a const environment or if the reference or pointer to the map is itself const. Its semantics are the same, but it returns only const references to the item it points to.

Member Type Documentation

QMapIterator::iterator_category

The type of iterator category, std::bidirectional_iterator_tag.

QMapIterator::pointer

Pointer to value_type.

QMapIterator::reference

Reference to value_type.

QMapIterator::value_type

The type of value.

Member Function Documentation

QMapIterator::QMapIterator ()

Creates an uninitialized iterator.

QMapIterator::QMapIterator ( QMapNode<K, T> * p )

Constructs an iterator starting at node p.

QMapIterator::QMapIterator ( const QMapIterator<K, T> & it )

Constructs a copy of the iterator, it.

T & QMapIterator::data ()

Returns a reference to the current item.

const T & QMapIterator::data () const

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Returns a const reference to the data of the current item.

const K & QMapIterator::key () const

Returns a const reference to the data of the current key.

bool QMapIterator::operator!= ( const QMapIterator<K, T> & it ) const

Compares the iterator to the it iterator and returns FALSE if they point to the same item; otherwise returns TRUE.

T & QMapIterator::operator* ()

Dereference operator. Returns a reference to the current item. The same as data().

const T & QMapIterator::operator* () const

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Dereference operator. Returns a const reference to the current item. The same as data().

QMapIterator<K, T> & QMapIterator::operator++ ()

Prefix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the map. Incrementing the iterator returned by end() causes undefined results.

QMapIterator<K, T> QMapIterator::operator++ ( int )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Postfix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the map. Incrementing the iterator returned by end() causes undefined results.

QMapIterator<K, T> & QMapIterator::operator-- ()

Prefix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the map. Decrementing the iterator returned by begin() causes undefined results.

QMapIterator<K, T> QMapIterator::operator-- ( int )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Postfix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the map. Decrementing the iterator returned by begin() causes undefined results.

bool QMapIterator::operator== ( const QMapIterator<K, T> & it ) const

Compares the iterator to the it iterator and returns TRUE if they point to the same item; otherwise returns FALSE.

Trademarks

Qt version 3.0.4