QMapIterator(3qt)QMapIterator(3qt)NAME
QMapIterator - Iterator for QMap
SYNOPSIS
#include <qmap.h>
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 )
DESCRIPTION
The QMapIterator class provides an iterator for QMap.
You cannot create an iterator by yourself. Instead, you must 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 machines, 8 bytes. That makes copying
iterators very fast. Iterators behave in a similar way to pointers, and
they are almost as fast as pointers. See the QMap example.
QMap is highly optimized for performance and memory usage, but the
trade-off is that you must be more careful. The only way to traverse a
map is to use iterators. QMap does not know about 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 must 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 only returns const references to the item it points to.
See also QMap, QMapConstIterator, Qt Template Library Classes, and Non-
GUI Classes.
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 DOCUMENTATIONQMapIterator::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's data.
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 current item's data.
const K & QMapIterator::key () const
Returns a const reference to the current item's 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's data.
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's
data. 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.
SEE ALSO
http://doc.trolltech.com/qmapiterator.html
http://www.trolltech.com/faq/tech.html
COPYRIGHT
Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the
license file included in the distribution for a complete license
statement.
AUTHOR
Generated automatically from the source code.
BUGS
If you find a bug in Qt, please report it as described in
http://doc.trolltech.com/bughowto.html. Good bug reports help us to
help you. Thank you.
The definitive Qt documentation is provided in HTML format; it is
located at $QTDIR/doc/html and can be read using Qt Assistant or with a
web browser. This man page is provided as a convenience for those users
who prefer man pages, although this format is not officially supported
by Trolltech.
If you find errors in this manual page, please report them to qt-
bugs@trolltech.com. Please include the name of the manual page
(qmapiterator.3qt) and the Qt version (3.3.8).
Trolltech AS 2 February 2007 QMapIterator(3qt)
