QMutableListIterator Class

The QMutableListIterator class provides a Java-style non-const iterator for QList and QQueue. More...

Header: #include <QMutableListIterator>
qmake: QT += core

Public Functions

QMutableListIterator(QList<T> &container)
bool findNext(const T &t)
bool findPrevious(const T &t)
bool hasNext() const
bool hasPrevious() const
void insert(const T &t)
T &next()
T &peekNext() const
T &peekPrevious() const
T &previous()
void remove()
void setValue(const T &t) const
void toBack()
void toFront()
T &value()
const T &value() const
QMutableListIterator<T> &operator=(QList<T> &container)

Detailed Description

The QMutableListIterator class provides a Java-style non-const iterator for QList and QQueue.

QList 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 QList member functions take an index as their first parameter, making it possible to access, insert, and remove items without using iterators.

QMutableListIterator<T> allows you to iterate over a QList<T> (or a QQueue<T>) and modify the list. If you don't want to modify the list (or have a const QList), use the slightly faster QListIterator<T> instead.

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


  QList<float> list;
  ...
  QMutableListIterator<float> i(list);
  while (i.hasNext())
      qDebug() << i.next();

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


  QMutableListIterator<float> i(list);
  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.

If you want to remove items as you iterate over the list, use remove(). If you want to modify the value of an item, use setValue(). If you want to insert a new item in the list, use insert().

Example:


  QMutableListIterator<int> i(list);
  while (i.hasNext()) {
      int val = i.next();
      if (val < 0) {
          i.setValue(-val);
      } else if (val == 0) {
          i.remove();
      }
  }

The example traverses a list, replacing negative numbers with their absolute values, and eliminating zeroes.

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

See also QListIterator and QList::iterator.

Member Function Documentation

QMutableListIterator::QMutableListIterator(QList<T> &container)

Default constructs an instance of QMutableListIterator.

bool QMutableListIterator::findNext(const T &t)

bool QMutableListIterator::findPrevious(const T &t)

bool QMutableListIterator::hasNext() const

bool QMutableListIterator::hasPrevious() const

void QMutableListIterator::insert(const T &t)

T &QMutableListIterator::next()

T &QMutableListIterator::peekNext() const

T &QMutableListIterator::peekPrevious() const

T &QMutableListIterator::previous()

void QMutableListIterator::remove()

void QMutableListIterator::setValue(const T &t) const

See also value().

void QMutableListIterator::toBack()

void QMutableListIterator::toFront()

T &QMutableListIterator::value()

See also setValue().

const T &QMutableListIterator::value() const

QMutableListIterator<T> &QMutableListIterator::operator=(QList<T> &container)

Copy-assignment operator.