Back to Doc.qt.io
Contact Us Blog Download Qt

const_iterator Class

class QMap::const_iterator

The QMap::const_iterator class provides an STL-style const iterator for QMap. More...

Public Types

iterator_category

Public Functions

const_iterator(const iterator &other)
const_iterator()
const Key &key() const
const T &value() const
const T &operator*() const
const_iterator &operator++()
const_iterator operator++(int)
const_iterator &operator--()
const_iterator operator--(int)
const T *operator->() const
bool operator!=(const const_iterator &lhs, const const_iterator &rhs)
bool operator==(const const_iterator &lhs, const const_iterator &rhs)

Detailed Description

QMap features both STL-style iterators and Java-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 a QMap. If you want to modify the QMap as you iterate over it, you must use QMap::iterator instead. It is generally good practice to use QMap::const_iterator on a non-const QMap as well, unless you need to change the QMap through the iterator. Const iterators are slightly faster, and can improve code readability.

The default QMap::const_iterator constructor creates an uninitialized iterator. You must initialize it using a QMap function like QMap::constBegin(), QMap::constEnd(), or QMap::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() << Qt::endl;

Unlike QHash, which stores its items in an arbitrary order, QMap stores its items ordered by key.

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.

Warning: Iterators on implicitly shared containers do not work exactly like STL-iterators. You should avoid copying a container while iterators are active on that container. For more information, read Implicit sharing iterator problem.

See also QMap::iterator, QMap::key_iterator, and QMapIterator.

Member Type Documentation

[alias] const_iterator::iterator_category

A synonym for std::bidirectional_iterator_tag indicating this iterator is a bidirectional iterator.

Member Function Documentation

const_iterator::const_iterator(const iterator &other)

Constructs a copy of other.

const_iterator::const_iterator()

Constructs an uninitialized iterator.

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

See also QMap::constBegin() and QMap::constEnd().

const Key &const_iterator::key() const

Returns the current item's key.

See also value().

const T &const_iterator::value() const

Returns the current item's value.

See also key() and operator*().

const T &const_iterator::operator*() const

Returns the current item's value.

Same as value().

See also key().

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 on QMap::end() leads to undefined results.

See also operator--().

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--()

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

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

See also operator++().

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 T *const_iterator::operator->() const

Returns a pointer to the current item's value.

See also value().

Related Non-Members

bool operator!=(const const_iterator &lhs, const const_iterator &rhs)

Returns true if lhs points to a different item than the rhs iterator; otherwise returns false.

See also operator==().

bool operator==(const const_iterator &lhs, const const_iterator &rhs)

Returns true if lhs points to the same item as the rhs iterator; otherwise returns false.

See also operator!=().

© 2024 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.