Home · All Namespaces · All Classes · Main Classes · Grouped Classes · Modules · Functions

QVectorIterator Class Reference
[QtCore module]

The QVectorIterator class provides a Java-style const iterator for QVector and QStack. More...

 #include <QVectorIterator>

List of all members, including inherited members

Public Functions

QVectorIterator ( const QVector<T> & vector )
bool findNext ( const T & value )
bool findPrevious ( const T & value )
bool hasNext () const
bool hasPrevious () const
const T & next ()
const T & peekNext () const
const T & peekPrevious () const
const T & previous ()
void toBack ()
void toFront ()
QVectorIterator & operator= ( const QVector<T> & vector )

Detailed Description

The QVectorIterator class provides a Java-style const iterator for QVector and QStack.

QVector has both Java-style iterators and STL-style iterators. The Java-style iterators are more high-level and easier to use than the STL-style iterators; on the other hand, they are slightly less efficient.

An alternative to using iterators is to use index positions. Most QVector member functions take an index as their first parameter, making it possible to access, insert, and remove items without using iterators.

QVectorIterator<T> allows you to iterate over a QVector<T> (or a QStack<T>). If you want to modify the vector as you iterate over it, use QMutableVectorIterator<T> instead.

The QVectorIterator constructor takes a QVector as argument. After construction, the iterator is located at the very beginning of the vector (before the first item). Here's how to iterate over all the elements sequentially:

 QVector<float> vector;
 ...
 QVectorIterator<float> i(vector);
 while (i.hasNext())
     qDebug() << i.next();

The next() function returns the next item in the vector and advances the iterator. Unlike STL-style iterators, Java-style iterators point between items rather than directly at items. The first call to next() advances the iterator to the position between the first and second item, and returns the first item; the second call to next() advances the iterator to the position between the second and third item, returning the second item; and so on.

Here's how to iterate over the elements in reverse order:

 QVectorIterator<float> i(vector);
 i.toBack();
 while (i.hasPrevious())
     qDebug() << i.previous();

If you want to find all occurrences of a particular value, use findNext() or findPrevious() in a loop.

Multiple iterators can be used on the same vector. If the vector is modified while a QVectorIterator is active, the QVectorIterator will continue iterating over the original vector, ignoring the modified copy.

Member Function Documentation

QVectorIterator::QVectorIterator ( const QVector<T> & vector )

Constructs an iterator for traversing vector. The iterator is set to be at the front of the vector (before the first item).

bool QVectorIterator::findNext ( const T & value )

Searches for value starting from the current iterator position forward. Returns true if value is found; otherwise returns false.

After the call, if value was found, the iterator is positioned just after the matching item; otherwise, the iterator is positioned at the back of the container.

bool QVectorIterator::findPrevious ( const T & value )

Searches for value starting from the current iterator position backward. Returns true if value is found; otherwise returns false.

After the call, if value was found, the iterator is positioned just before the matching item; otherwise, the iterator is positioned at the front of the container.

bool QVectorIterator::hasNext () const

Returns true if there is at least one item ahead of the iterator, i.e. the iterator is not at the back of the container; otherwise returns false.

bool QVectorIterator::hasPrevious () const

Returns true if there is at least one item behind the iterator, i.e. the iterator is not at the front of the container; otherwise returns false.

const T & QVectorIterator::next ()

Returns the next item and advances the iterator by one position.

Calling this function on an iterator located at the back of the container leads to undefined results.

See also hasNext(), peekNext(), and previous().

const T & QVectorIterator::peekNext () const

Returns the next item without moving the iterator.

Calling this function on an iterator located at the back of the container leads to undefined results.

See also hasNext(), next(), and peekPrevious().

const T & QVectorIterator::peekPrevious () const

Returns the previous item without moving the iterator.

Calling this function on an iterator located at the front of the container leads to undefined results.

See also hasPrevious(), previous(), and peekNext().

const T & QVectorIterator::previous ()

Returns the previous item and moves the iterator back by one position.

Calling this function on an iterator located at the front of the container leads to undefined results.

See also hasPrevious(), peekPrevious(), and next().

void QVectorIterator::toBack ()

Moves the iterator to the back of the container (after the last item).

void QVectorIterator::toFront ()

Moves the iterator to the front of the container (before the first item).

QVectorIterator & QVectorIterator::operator= ( const QVector<T> & vector )

Makes the iterator operate on vector. The iterator is set to be at the front of the vector (before the first item).

QVectorIterator Class Reference[QtCore module]