Qt 5.6 | Qt Core | C++ Classes | QMutableSetIterator

Qt 5.6.2 Reference Documentation

# QMutableSetIterator Class

The QMutableSetIterator class provides a Java-style non-const iterator for QSet. More...

Header: | #include <QMutableSetIterator>
qmake: | QT += core
Since: | Qt 4.2

- List of all members, including inherited members

## Public Functions

| QMutableSetIterator(QSet<T> &set)
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 | remove()
void | toBack()
void | toFront()
const T & | value() const
QMutableSetIterator & | operator=(QSet<T> &set)

## Detailed Description

The QMutableSetIterator class provides a Java-style non-const iterator for QSet.

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

QMutableSetIterator<T> allows you to iterate over a QSet<T> and remove items from the set as you iterate. If you don't want to modify the set (or have a const QSet), use the slightly faster QSetIterator<T> instead.

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

      QSet<float> set;
      ...
      QMutableSetIterator<float> i(set);
      while (i.hasNext())
          qDebug() << i.next();

The next() function returns the next item in the set 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:

      QMutableSetIterator<float> i(set);
      i.toBack();
      while (i.hasPrevious())
          qDebug() << i.previous();

If you want to remove items as you iterate over the set, use remove().

Only one mutable iterator can be active on a given set at any time. Furthermore, no changes should be done directly to the set while the iterator is active (as opposed to through the iterator), since this could invalidate the iterator and lead to undefined behavior.

See also QSetIterator and QSet::iterator.

## Member Function Documentation

### QMutableSetIterator::QMutableSetIterator(QSet<T> &set)

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

See also operator=().

### bool QMutableSetIterator::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.

See also findPrevious().

### bool QMutableSetIterator::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.

See also findNext().

### bool QMutableSetIterator::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`.

See also hasPrevious() and next().

### bool QMutableSetIterator::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`.

See also hasNext() and previous().

### const T &QMutableSetIterator::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 &QMutableSetIterator::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 &QMutableSetIterator::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 &QMutableSetIterator::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 QMutableSetIterator::remove()

Removes the last item that was jumped over using one of the traversal functions (next(), previous(), findNext(), findPrevious()).

Example:

      QMutableSetIterator<int> i(set);
      while (i.hasNext()) {
          int val = i.next();
          if (val < -32768 || val > 32767)
              i.remove();
      }

See also value().

### void QMutableSetIterator::toBack()

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

See also toFront() and previous().

### void QMutableSetIterator::toFront()

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

See also toBack() and next().

### const T &QMutableSetIterator::value() const

Returns the value of the last item that was jumped over using one of the traversal functions (next(), previous(), findNext(), findPrevious()).

After a call to next() or findNext(), value() is equivalent to peekPrevious(). After a call to previous() or findPrevious(), value() is equivalent to peekNext().

### QMutableSetIterator &QMutableSetIterator::operator=(QSet<T> &set)

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

See also toFront() and toBack().