\inmodule QtCore More...

#include <qjsonarray.h>

Collaboration diagram for QJsonArray::iterator:

Public Types
typedef std::random_access_iterator_tag	iterator_category
	A synonym for {std::random_access_iterator_tag} indicating this iterator is a random access iterator.

typedef qsizetype	difference_type

typedef QJsonValue	value_type

typedef QJsonValueRef	reference

typedef QJsonValueRef *	pointer

Public Member Functions
	iterator ()
	Constructs an uninitialized iterator.

	iterator (QJsonArray *array, qsizetype index)

constexpr	iterator (const iterator &other)=default

iterator &	operator= (const iterator &other)

QJsonValueRef	operator* () const
	Returns a modifiable reference to the current item.

const QJsonValueConstRef *	operator-> () const
	Returns a pointer to a modifiable reference to the current item.

QJsonValueRef *	operator-> ()

QJsonValueRef	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}).

iterator &	operator++ ()
	The prefix {++} operator, {++it}, advances the iterator to the next item in the array and returns an iterator to the new current item.

iterator	operator++ (int)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.The postfix {++} operator, {it++}, advances the iterator to the next item in the array and returns an iterator to the previously current item.

iterator &	operator-- ()
	The prefix {–} operator, {–it}, makes the preceding item current and returns an iterator to the new current item.

iterator	operator-- (int)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.The postfix {–} operator, {it–}, makes the preceding item current and returns an iterator to the previously current item.

iterator &	operator+= (qsizetype j)
	Advances the iterator by j items.

iterator &	operator-= (qsizetype j)
	Makes the iterator go back by j items.

iterator	operator+ (qsizetype j) const
	Returns an iterator to the item at j positions forward from this iterator.

iterator	operator- (qsizetype j) const
	Returns an iterator to the item at j positions backward from this iterator.

qsizetype	operator- (iterator j) const
	Returns the number of items between the item pointed to by other and the item pointed to by this iterator.

Friends
class	QJsonArray

bool	comparesEqual (const iterator &lhs, const iterator &rhs) noexcept

Qt::strong_ordering	compareThreeWay (const iterator &lhs, const iterator &rhs)

bool	comparesEqual (const iterator &lhs, const const_iterator &rhs) noexcept

Qt::strong_ordering	compareThreeWay (const iterator &lhs, const const_iterator &rhs)

Detailed Description

\inmodule QtCore

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

\compares strong \compareswith strong QJsonArray::const_iterator \endcompareswith

QJsonArray::iterator allows you to iterate over a QJsonArray and to modify the array item associated with the iterator. If you want to iterate over a const QJsonArray, use QJsonArray::const_iterator instead. It is generally a good practice to use QJsonArray::const_iterator on a non-const QJsonArray as well, unless you need to change the QJsonArray through the iterator. Const iterators are slightly faster and improves code readability.

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

Most QJsonArray functions accept an integer index rather than an iterator. For that reason, iterators are rarely useful in connection with QJsonArray. One place where STL-style iterators do make sense is as arguments to \l{generic algorithms}.

Multiple iterators can be used on the same array. However, be aware that any non-const function call performed on the QJsonArray will render all existing iterators undefined.

See also: QJsonArray::const_iterator

Definition at line 74 of file qjsonarray.h.

Member Typedef Documentation

◆ difference_type

typedef qsizetype QJsonArray::iterator::difference_type

Definition at line 77 of file qjsonarray.h.

◆ iterator_category

typedef std::random_access_iterator_tag QJsonArray::iterator::iterator_category

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

Definition at line 76 of file qjsonarray.h.

◆ pointer

typedef QJsonValueRef* QJsonArray::iterator::pointer

Definition at line 80 of file qjsonarray.h.

◆ reference

typedef QJsonValueRef QJsonArray::iterator::reference

Definition at line 79 of file qjsonarray.h.

◆ value_type

typedef QJsonValue QJsonArray::iterator::value_type

Definition at line 78 of file qjsonarray.h.

Constructor & Destructor Documentation

◆ iterator() [1/3]

QJsonArray::iterator::iterator ( )

inline

Constructs an uninitialized iterator.

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

See also: QJsonArray::begin(), QJsonArray::end()

Definition at line 82 of file qjsonarray.h.

◆ iterator() [2/3]

QJsonArray::iterator::iterator	(	QJsonArray *	array,
		qsizetype	index )

inlineexplicit

Definition at line 83 of file qjsonarray.h.

◆ iterator() [3/3]

QJsonArray::iterator::iterator ( const iterator & other )

constexprdefault

Member Function Documentation

◆ operator*()

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

inline

Returns a modifiable reference to the current item.

You can change the value of an item by using operator*() 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 character in the QJsonArray of QJsonObject from which you got the reference.

Definition at line 92 of file qjsonarray.h.

◆ operator+()

iterator QJsonArray::iterator::operator+ ( qsizetype j ) const

inline

Returns an iterator to the item at j positions forward from this iterator.

If j is negative, the iterator goes backward.

See also: operator-(), operator+=()

Definition at line 123 of file qjsonarray.h.

◆ operator++() [1/2]

iterator & QJsonArray::iterator::operator++ ( )

inline

The prefix {++} operator, {++it}, advances the iterator to the next item in the array and returns an iterator to the new current item.

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

See also: operator--()

Definition at line 117 of file qjsonarray.h.

◆ operator++() [2/2]

iterator QJsonArray::iterator::operator++ ( int )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.The postfix {++} operator, {it++}, advances the iterator to the next item in the array and returns an iterator to the previously current item.

Definition at line 118 of file qjsonarray.h.

◆ operator+=()

iterator & QJsonArray::iterator::operator+= ( qsizetype j )

inline

Advances the iterator by j items.

If j is negative, the iterator goes backward.

See also: operator-=(), operator+()

Definition at line 121 of file qjsonarray.h.

◆ operator-() [1/2]

qsizetype QJsonArray::iterator::operator- ( iterator j ) const

inline

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

Definition at line 125 of file qjsonarray.h.

◆ operator-() [2/2]

iterator QJsonArray::iterator::operator- ( qsizetype j ) const

inline

Returns an iterator to the item at j positions backward from this iterator.

If j is negative, the iterator goes forward.

See also: operator+(), operator-=()

Definition at line 124 of file qjsonarray.h.

◆ operator--() [1/2]

iterator & QJsonArray::iterator::operator-- ( )

inline

The prefix {–} operator, {–it}, makes the preceding item current and returns an iterator to the new current item.

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

See also: operator++()

Definition at line 119 of file qjsonarray.h.

◆ operator--() [2/2]

iterator QJsonArray::iterator::operator-- ( int )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.The postfix {–} operator, {it–}, makes the preceding item current and returns an iterator to the previously current item.

Definition at line 120 of file qjsonarray.h.

◆ operator-=()

iterator & QJsonArray::iterator::operator-= ( qsizetype j )

inline

Makes the iterator go back by j items.

If j is negative, the iterator goes forward.

See also: operator+=(), operator-()

Definition at line 122 of file qjsonarray.h.

◆ operator->() [1/2]

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

inline

Definition at line 94 of file qjsonarray.h.

◆ operator->() [2/2]

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

inline

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

Definition at line 93 of file qjsonarray.h.

◆ operator=()

iterator & QJsonArray::iterator::operator= ( const iterator & other )

inline

Definition at line 86 of file qjsonarray.h.

◆ operator[]()

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

inline

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

Definition at line 95 of file qjsonarray.h.

Friends And Related Symbol Documentation

◆ comparesEqual [1/2]

bool comparesEqual	(	const iterator &	lhs,
		const const_iterator &	rhs )

friend

Definition at line 164 of file qjsonarray.h.

◆ comparesEqual [2/2]

bool comparesEqual	(	const iterator &	lhs,
		const iterator &	rhs )

friend

Definition at line 154 of file qjsonarray.h.

◆ compareThreeWay [1/2]

Qt::strong_ordering compareThreeWay	(	const iterator &	lhs,
		const const_iterator &	rhs )

friend

Definition at line 168 of file qjsonarray.h.

◆ compareThreeWay [2/2]

Qt::strong_ordering compareThreeWay	(	const iterator &	lhs,
		const iterator &	rhs )

friend

Definition at line 158 of file qjsonarray.h.

◆ QJsonArray

friend class QJsonArray

friend

Definition at line 176 of file qjsonarray.h.

The documentation for this class was generated from the following files:

qtbase/src/corelib/serialization/qjsonarray.h (029bb47e12d63e186663714c3776d3654285496b)
qtbase/src/corelib/serialization/qjsonarray.cpp (029bb47e12d63e186663714c3776d3654285496b)

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ difference_type

◆ iterator_category

◆ pointer

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ iterator() [1/3]

◆ iterator() [2/3]

◆ iterator() [3/3]

Member Function Documentation

◆ operator*()

◆ operator+()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator=()

◆ operator[]()

Friends And Related Symbol Documentation

◆ comparesEqual [1/2]

◆ comparesEqual [2/2]

◆ compareThreeWay [1/2]

◆ compareThreeWay [2/2]

◆ QJsonArray