QJsonObject::iterator Class | Qt Core | Qt 6.11.1
Description: The QJsonObject::iterator class provides an STL-style non-const iterator for QJsonObject.

- Qt 6.11
- Qt Core
- C++ Classes
- iterator
- Qt 6.11.1 Reference Documentation

# QJsonObject::iterator Class

class QJsonObject::iterator

The QJsonObject::iterator class provides an STL-style non-const iterator for QJsonObject. More...

- List of all members, including inherited members
- iterator is part of JSON Support in Qt.

This class is strongly comparable.

This class is strongly comparable with QJsonObject::const_iterator.

## Public Types

| iterator_category

## Public Functions

| iterator()
QString | key() const
`(since 6.10)` QAnyStringView | keyView() const
QJsonValueRef | value() const
QJsonValueRef | operator*() const
QJsonObject::iterator | operator+(qsizetype j) const
QJsonObject::iterator & | operator++()
QJsonObject::iterator | operator++(int)
QJsonObject::iterator & | operator+=(qsizetype j)
qsizetype | operator-(QJsonObject::iterator other) const
QJsonObject::iterator | operator-(qsizetype j) const
QJsonObject::iterator & | operator--()
QJsonObject::iterator | operator--(int)
QJsonObject::iterator & | operator-=(qsizetype j)
QJsonValueRef * | operator->()
const QJsonValueConstRef * | operator->() const
QJsonValueRef | operator[](qsizetype j) const

## Related Non-Members

bool | operator!=(const QJsonObject::iterator &lhs, const QJsonObject::const_iterator &rhs)
bool | operator!=(const QJsonObject::iterator &lhs, const QJsonObject::iterator &rhs)
bool | operator<(const QJsonObject::iterator &lhs, const QJsonObject::const_iterator &rhs)
bool | operator<(const QJsonObject::iterator &lhs, const QJsonObject::iterator &rhs)
bool | operator<=(const QJsonObject::iterator &lhs, const QJsonObject::const_iterator &rhs)
bool | operator<=(const QJsonObject::iterator &lhs, const QJsonObject::iterator &rhs)
bool | operator==(const QJsonObject::iterator &lhs, const QJsonObject::const_iterator &rhs)
bool | operator==(const QJsonObject::iterator &lhs, const QJsonObject::iterator &rhs)
bool | operator>(const QJsonObject::iterator &lhs, const QJsonObject::const_iterator &rhs)
bool | operator>(const QJsonObject::iterator &lhs, const QJsonObject::iterator &rhs)
bool | operator>=(const QJsonObject::iterator &lhs, const QJsonObject::const_iterator &rhs)
bool | operator>=(const QJsonObject::iterator &lhs, const QJsonObject::iterator &rhs)

## Detailed Description

QJsonObject::iterator allows you to iterate over a QJsonObject and to modify the value (but not the key) stored under a particular key. If you want to iterate over a const QJsonObject, you should use QJsonObject::const_iterator. It is generally good practice to use QJsonObject::const_iterator on a non-const QJsonObject as well, unless you need to change the QJsonObject through the iterator. Const iterators are slightly faster, and improve code readability.

The default QJsonObject::iterator constructor creates an uninitialized iterator. You must initialize it using a QJsonObject function like QJsonObject::begin(), QJsonObject::end(), or QJsonObject::find() before you can start iterating.

Multiple iterators can be used on the same object. Existing iterators will however become dangling once the object gets modified.

See also QJsonObject::const_iterator, JSON Support in Qt, and Saving and Loading a Game.

## Member Type Documentation

### iterator::iterator_category

A synonym for std::random_access_iterator_tag indicating this iterator is a random-access iterator.

Note: In Qt versions before 5.6, this was set by mistake to std::bidirectional_iterator_tag.

## Member Function Documentation

### 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 QJsonObject::begin() and QJsonObject::end().

### QString 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 QJsonObject::erase() followed by QJsonObject::insert().

See also value() and keyView().

### `[since 6.10]` QAnyStringView iterator::keyView() const

Returns the current item's key as a QAnyStringView. This function does not allocate memory.

Since QJsonObject stores keys in US-ASCII, UTF-8 or UTF-16, the returned QAnyStringView may be in any of these encodings.

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

This function was introduced in Qt 6.10.

See also key() and value().

### QJsonValueRef iterator::value() const

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

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

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

See also key(), keyView(), and operator*().

### QJsonValueRef iterator::operator*() const

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

Same as value().

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

See also key() and keyView().

### QJsonObject::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-().

### QJsonObject::iterator &iterator::operator++()

The prefix `++` operator, `++i`, advances the iterator to the next item in the object and returns an iterator to the new current item.

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

See also operator--().

### QJsonObject::iterator iterator::operator++(int)

The postfix `++` operator, `i++`, advances the iterator to the next item in the object and returns an iterator to the previously current item.

This is an overloaded function.

### QJsonObject::iterator &iterator::operator+=(qsizetype j)

Advances the iterator by j items. If j is negative, the iterator goes backward.

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

### qsizetype iterator::operator-(QJsonObject::iterator other) const

Returns the number of items between the item pointed to by other and the item pointed to by this iterator.

### QJsonObject::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+().

### QJsonObject::iterator &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 QJsonObject::begin() leads to undefined results.

See also operator++().

### QJsonObject::iterator iterator::operator--(int)

The postfix `--` operator, `i--`, makes the preceding item current and returns an iterator pointing to the previously current item.

This is an overloaded function.

### QJsonObject::iterator &iterator::operator-=(qsizetype j)

Makes the iterator go back by j items. If j is negative, the iterator goes forward.

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

### QJsonValueRef *iterator::operator->()

Returns a pointer to a modifiable reference to the current item.

### const QJsonValueConstRef *iterator::operator->() const

Returns a pointer to a constant reference to the current item.

### QJsonValueRef iterator::operator[](qsizetype j) const

Returns a modifiable reference to the item at offset j from the item pointed to by this iterator (the item at position `*this + j`).

This function is provided to make QJsonObject iterators behave like C++ pointers.

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

See also operator+().

## Related Non-Members

### `[noexcept]` bool operator!=(const QJsonObject::iterator &lhs, const QJsonObject::iterator &rhs)

### `[noexcept]` bool operator!=(const QJsonObject::iterator &lhs, const QJsonObject::const_iterator &rhs)

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

See also operator==().

### `[noexcept]` bool operator<(const QJsonObject::iterator &lhs, const QJsonObject::iterator &rhs)

### `[noexcept]` bool operator<(const QJsonObject::iterator &lhs, const QJsonObject::const_iterator &rhs)

Returns `true` if the item pointed to by lhs iterator is less than the item pointed to by the rhs iterator.

### `[noexcept]` bool operator<=(const QJsonObject::iterator &lhs, const QJsonObject::iterator &rhs)

### `[noexcept]` bool operator<=(const QJsonObject::iterator &lhs, const QJsonObject::const_iterator &rhs)

Returns `true` if the item pointed to by lhs iterator is less than or equal to the item pointed to by the rhs iterator.

### `[noexcept]` bool operator==(const QJsonObject::iterator &lhs, const QJsonObject::iterator &rhs)

### `[noexcept]` bool operator==(const QJsonObject::iterator &lhs, const QJsonObject::const_iterator &rhs)

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

See also operator!=().

### `[noexcept]` bool operator>(const QJsonObject::iterator &lhs, const QJsonObject::iterator &rhs)

### `[noexcept]` bool operator>(const QJsonObject::iterator &lhs, const QJsonObject::const_iterator &rhs)

Returns `true` if the item pointed to by lhs iterator is greater than the item pointed to by the rhs iterator.

### `[noexcept]` bool operator>=(const QJsonObject::iterator &lhs, const QJsonObject::iterator &rhs)

### `[noexcept]` bool operator>=(const QJsonObject::iterator &lhs, const QJsonObject::const_iterator &rhs)

Returns `true` if the item pointed to by lhs iterator is greater than or equal to the item pointed to by the rhs iterator.