QMutableMapIterator Class

The QMutableMapIterator class provides a Java-style non-const iterator for QMap and QMultiMap. More...

Header: #include <QMutableMapIterator>
qmake: QT += core

Public Functions

QMutableMapIterator(QMap<Key, T> &map)
QMutableMapIterator<Key, T> &operator=(QMap<Key, T> &container)
bool findNext(const T &value)
bool findPrevious(const T &value)
bool hasNext() const
bool hasPrevious() const
const Key &key() const
QMutableMapIterator::Item next()
QMutableMapIterator::Item peekNext() const
QMutableMapIterator::Item peekPrevious() const
QMutableMapIterator::Item previous()
void remove()
void setValue(const T &value)
void toBack()
void toFront()
const T &value() const
T &value()

Detailed Description

QMap has both Java-style iterators and STL-style iterators. The Java-style iterators are more high-level and easier to use than the STL-style iterators; on the other hand, they are slightly less efficient.

QMutableMapIterator<Key, T> allows you to iterate over a QMap (or a QMultiMap) and modify the map. If you don't want to modify the map (or have a const QMap), use the slightly faster QMapIterator instead.

The QMutableMapIterator constructor takes a QMap as argument. After construction, the iterator is located at the very beginning of the map (before the first item). Here's how to iterate over all the elements sequentially:

QMap<int, QWidget *> map;
QMutableMapIterator<int, QWidget *> i(map);
while (i.hasNext()) {
    qDebug() << i.key() << ": " << i.value();

The next() function returns the next item in the map and advances the iterator. The key() and value() functions return the key and value of the last item that was jumped over.

Unlike STL-style iterators, Java-style iterators point between items rather than directly at items. The first call to next() advances the iterator to the position between the first and second item, and returns the first item; the second call to next() advances the iterator to the position between the second and third item; and so on.

Here's how to iterate over the elements in reverse order:

QMutableMapIterator<int, QWidget *> i(map);
while (i.hasPrevious()) {
    qDebug() << i.key() << ": " << i.value();

If you want to find all occurrences of a particular value, use findNext() or findPrevious() in a loop. For example:

QMutableMapIterator<int, QWidget *> i(map);
while (i.findNext(widget)) {
    qDebug() << "Found widget " << widget << " under key "
             << i.key();

If you want to remove items as you iterate over the map, use remove(). If you want to modify the value of an item, use setValue().


QMutableMapIterator<QString, QString> i(map);
while (i.hasNext()) {
    if (i.key() == i.value())

The example removes all (key, value) pairs where the key and the value are the same.

Only one mutable iterator can be active on a given map at any time. Furthermore, no changes should be done directly to the map while the iterator is active (as opposed to through the iterator), since this could invalidate the iterator and lead to undefined behavior.

See also QMapIterator and QMap::iterator.

© 2019 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.