Iterator Class

Member Function Documentation

Returns true if other points to the same entry in the map as this iterator; otherwise returns false.

See also operator!=().

Returns true if other points to a different entry in the map than this iterator; otherwise returns false.

See also operator==().

Returns true if the entry in the map pointed to by this iterator occurs before the entry pointed to by the other iterator.

Returns true if the entry in the map pointed to by this iterator occurs before or is the same entry as is pointed to by the other iterator.

Returns true if the entry in the map pointed to by this iterator occurs after the entry pointed to by the other iterator.

Returns true if the entry in the map pointed to by this iterator occurs after or is the same entry as is pointed to by the other iterator.

[constexpr noexcept] Iterator::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 QCborMap::begin() and QCborMap::end().

[constexpr noexcept] Iterator::Iterator(const QCborMap::Iterator &other)

Constructs an iterator as a copy of other.

QCborValue Iterator::key() const

Returns the current item's key.

There is no direct way of changing an item's key through an iterator, although it can be done by calling QCborMap::erase() followed by QCborMap::insert().

See also value().

QCborValueRef Iterator::value() const

Returns a modifiable reference to the current item's value.

You can change the value for a key by using value() on the left side of an assignment.

The return value is of type QCborValueRef, a helper class for QCborArray and QCborMap. When you get an object of type QCborValueRef, you can use it as if it were a reference to a QCborValue. If you assign to it, the assignment will apply to the element in the QCborArray or QCborMap from which you got the reference.

See also key() and operator*().

QCborMap::Iterator::value_type Iterator::operator*() const

Returns a pair containing the current item's key and a modifiable reference to the current item's value.

The second element of the pair is of type QCborValueRef, a helper class for QCborArray and QCborMap. When you get an object of type QCborValueRef, you can use it as if it were a reference to a QCborValue. If you assign to it, the assignment will apply to the element in the QCborArray or QCborMap from which you got the reference.

See also key() and value().

QCborMap::Iterator Iterator::operator+(qsizetype j) const

Returns an iterator to the item at j positions forward from this iterator. If j is negative, the iterator goes backward.

See also operator-().

QCborMap::Iterator &Iterator::operator++()

The prefix ++ operator, ++i, advances the iterator to the next item in the map and returns this iterator.

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

See also operator--().

QCborMap::Iterator 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.

QCborMap::Iterator &Iterator::operator+=(qsizetype j)

Advances the iterator by j items. If j is negative, the iterator goes backward. Returns a reference to this iterator.

See also operator-=() and operator+().

QCborMap::Iterator Iterator::operator-(qsizetype j) const

Returns an iterator to the item at j positions backward from this iterator. If j is negative, the iterator goes forward.

See also operator+().

qsizetype Iterator::operator-(QCborMap::Iterator j) const

Returns the position of the item at iterator j relative to the item at this iterator. If the item at j is forward of this time, the returned value is negative.

See also operator+().

QCborMap::Iterator &Iterator::operator--()

The prefix -- operator, --i, makes the preceding item current and returns this iterator.

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

See also operator++().

QCborMap::Iterator 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.

QCborMap::Iterator &Iterator::operator-=(qsizetype j)

Makes the iterator go back by j items. If j is negative, the iterator goes forward. Returns a reference to this iterator.

See also operator+=() and operator-().

const QCborValueConstRef *Iterator::operator->() const

Returns a pointer to a modifiable reference to the current pair's value.

QCborMap::Iterator &Iterator::operator=(const QCborMap::Iterator &other)

Makes this iterator a copy of other and returns a reference to this iterator.