The QIterator is a template class that allows iteration over a container in a QVariant. More...

#include <qiterable.h>

Inheritance diagram for QIterator< Container >:

Collaboration diagram for QIterator< Container >:

Public Types
using	difference_type = qsizetype

Public Member Functions
	QIterator (QIterable< Container > iterable, void iterator)
	Creates an iterator from an iterable and a pointer to a native iterator.

bool	operator== (const QIterator &o) const
	Returns `true` if other points to the same item as this iterator; otherwise returns `false`.

bool	operator!= (const QIterator &o) const
	Returns `true` if other points to a different item than this iterator; otherwise returns `false`.

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

QIterator	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 container and returns an iterator to the previously current item.

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

QIterator	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.

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

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

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

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

qsizetype	operator- (const QIterator &j) const
	Returns the distance between the two iterators.

Public Member Functions inherited from QBaseIterator< Container >
void *	mutableIterator ()
	Returns a non-const pointer to the internal native iterator.

const void *	constIterator () const
	Returns a const pointer to the internal native iterator.

Container	metaContainer () const

Friends
QIterator	operator+ (qsizetype j, const QIterator &k)
	Returns an iterator to the item at j positions forward from iterator k.

Additional Inherited Members
Protected Member Functions inherited from QBaseIterator< Container >
	QBaseIterator ()=default

	QBaseIterator (const QIterable< Container > iterable, void iterator)

	QBaseIterator (QIterable< Container > iterable, void iterator)

	QBaseIterator (QBaseIterator &&other)

	QBaseIterator (const QBaseIterator &other)

	~QBaseIterator ()

QBaseIterator &	operator= (QBaseIterator &&other)

QBaseIterator &	operator= (const QBaseIterator &other)

QIterable< Container > *	mutableIterable () const

const QIterable< Container > *	constIterable () const

void	initIterator (const void *copy)

void	clearIterator ()

Detailed Description

template<class Container>
class QIterator< Container >

The QIterator is a template class that allows iteration over a container in a QVariant.

Since: 6.0 \inmodule QtCore

A QIterator can only be created by a QIterable instance, and can be used in a way similar to other stl-style iterators. Generally, QIterator should not be used directly, but through its derived classes provided by QSequentialIterable and QAssociativeIterable.

See also: QIterable

Definition at line 214 of file qiterable.h.

Member Typedef Documentation

◆ difference_type

template<class Container >

using QIterator< Container >::difference_type = qsizetype

Definition at line 217 of file qiterable.h.

Constructor & Destructor Documentation

◆ QIterator()

template<class Container >

template< class Container > QIterator< Container >::QIterator	(	QIterable< Container > *	iterable,
		void *	iterator
	)

inlineexplicit

Creates an iterator from an iterable and a pointer to a native iterator.

Definition at line 219 of file qiterable.h.

References Q_ASSERT.

Member Function Documentation

◆ operator!=()

template<class Container >

template< class Container > bool QIterator< Container >::operator!= ( const QIterator< Container > & o ) const

inline

Returns true if other points to a different item than this iterator; otherwise returns false.

See also: operator==()

Definition at line 230 of file qiterable.h.

References QBaseIterator< Container >::constIterator(), and QBaseIterator< Container >::metaContainer().

Here is the call graph for this function:

◆ operator+()

template<class Container >

template< class Container > QIterator< Container > QIterator< Container >::operator+ ( qsizetype j ) const

inline

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

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

Definition at line 279 of file qiterable.h.

References j, QBaseIterator< Container >::metaContainer(), QIterable< Container >::mutableIterable(), QBaseIterator< Container >::mutableIterable(), and this.

Here is the call graph for this function:

◆ operator++() [1/2]

template<class Container >

template< class Container > QIterator< Container > & QIterator< Container >::operator++ ( )

inline

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

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

See also: operator--()

Definition at line 235 of file qiterable.h.

References QBaseIterator< Container >::metaContainer(), and QBaseIterator< Container >::mutableIterator().

Here is the call graph for this function:

◆ operator++() [2/2]

template<class Container >

template< class Container > QIterator< Container > QIterator< Container >::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 container and returns an iterator to the previously current item.

Definition at line 241 of file qiterable.h.

References QBaseIterator< Container >::metaContainer(), QIterable< Container >::mutableIterable(), QBaseIterator< Container >::mutableIterable(), QBaseIterator< Container >::mutableIterator(), and this.

Here is the call graph for this function:

◆ operator+=()

template<class Container >

template< class Container > QIterator< Container > & QIterator< Container >::operator+= ( qsizetype j )

inline

Advances the iterator by j items.

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

Definition at line 267 of file qiterable.h.

References QBaseIterator< Container >::metaContainer(), and QBaseIterator< Container >::mutableIterator().

Here is the call graph for this function:

◆ operator-() [1/2]

template<class Container >

template< class Container > qsizetype QIterator< Container >::operator- ( const QIterator< Container > & j ) const

inline

Returns the distance between the two iterators.

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

Definition at line 299 of file qiterable.h.

References QBaseIterator< Container >::constIterator(), and QBaseIterator< Container >::metaContainer().

Here is the call graph for this function:

◆ operator-() [2/2]

template<class Container >

template< class Container > QIterator< Container > QIterator< Container >::operator- ( qsizetype j ) const

inline

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

If the container in the QVariant does not support bi-directional iteration, calling this function leads to undefined results.

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

Definition at line 289 of file qiterable.h.

References j, QBaseIterator< Container >::metaContainer(), QIterable< Container >::mutableIterable(), QBaseIterator< Container >::mutableIterable(), and this.

Here is the call graph for this function:

◆ operator--() [1/2]

template<class Container >

template< class Container > QIterator< Container > & QIterator< Container >::operator-- ( )

inline

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

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

If the container in the QVariant does not support bi-directional iteration, calling this function leads to undefined results.

See also: operator++(), QIterable::canReverseIterate()

Definition at line 251 of file qiterable.h.

References QBaseIterator< Container >::metaContainer(), and QBaseIterator< Container >::mutableIterator().

Here is the call graph for this function:

◆ operator--() [2/2]

template<class Container >

template< class Container > QIterator< Container > QIterator< Container >::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.

If the container in the QVariant does not support bi-directional iteration, calling this function leads to undefined results.

See also: QIterable::canReverseIterate()

Definition at line 257 of file qiterable.h.

References QBaseIterator< Container >::metaContainer(), QIterable< Container >::mutableIterable(), QBaseIterator< Container >::mutableIterable(), QBaseIterator< Container >::mutableIterator(), and this.

Here is the call graph for this function:

◆ operator-=()

template<class Container >

template< class Container > QIterator< Container > & QIterator< Container >::operator-= ( qsizetype j )

inline

Makes the iterator go back by j items.

If the container in the QVariant does not support bi-directional iteration, calling this function leads to undefined results.

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

Definition at line 273 of file qiterable.h.

References QBaseIterator< Container >::metaContainer(), and QBaseIterator< Container >::mutableIterator().

Here is the call graph for this function:

◆ operator==()

template<class Container >

template< class Container > bool QIterator< Container >::operator== ( const QIterator< Container > & o ) const

inline

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

See also: operator!=()

Definition at line 225 of file qiterable.h.

References QBaseIterator< Container >::constIterator(), and QBaseIterator< Container >::metaContainer().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ operator+

template<class Container >

template< class Container > QIterator< Container > QIterator< Container >::operator+	(	qsizetype	j,
		const QIterator< Container > &	k
	)

friend

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

Definition at line 304 of file qiterable.h.

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

qtbase/src/corelib/kernel/qiterable.h
qtbase/src/corelib/kernel/qiterable.cpp

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ difference_type

Constructor & Destructor Documentation

◆ QIterator()

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

Friends And Related Symbol Documentation

◆ operator+