Класс QMutableMapIterator

Класс QMutableMapIterator предоставляет итератор (без модификатора const) в стиле Java для QMap и QMultiMap. Подробнее...

• Список всех членов, включая унаследованные

Открытые функции

Подробное описание

Класс QMutableMapIterator предоставляет итератор (без модификатора const) в стиле Java для QMap и QMultiMap.

QMap имеет как итераторы в стиле Java, так и итераторы в стиле STL. Итераторы в стиле Java более высокого уровня и проще в использовании, чем итераторы в стиле STL; с другой стороны, они немного менее эффективны.

QMutableMapIterator<Key, T> позволяет перебирать QMap (или QMultiMap) и изменять карту. Если вам не нужно изменять карту (или у вас есть QMap с модификатором const), используйте немного более быстрый QMapIterator.

Конструктор QMutableMapIterator принимает QMap в качестве аргумента. После создания итератор находится в начале карты (перед первым элементом). Вот как перебрать все элементы последовательно:

QMap<int, QWidget *> map;
...
QMutableMapIterator<int, QWidget *> i(map);
while (i.hasNext()) {
    i.next();
    qDebug() << i.key() << ": " << i.value();
}

Функция next() возвращает следующий элемент в карте и перемещает итератор вперёд. Функции key() и value() возвращают ключ и значение последнего обработанного элемента.

В отличие от итераторов в стиле STL, итераторы в стиле Java указывают между элементами, а не непосредственно на элементы. Первый вызов next() перемещает итератор в позицию между первым и вторым элементом и возвращает первый элемент; второй вызов next() перемещает итератор в позицию между вторым и третьим элементом и так далее.

Вот как перебрать элементы в обратном порядке:

QMutableMapIterator<int, QWidget *> i(map);
i.toBack();
while (i.hasPrevious()) {
    i.previous();
    qDebug() << i.key() << ": " << i.value();
}

Если вы хотите найти все вхождения определенного значения, используйте findNext() или findPrevious() в цикле. Например:

QMutableMapIterator<int, QWidget *> i(map);
while (i.findNext(widget)) {
    qDebug() << "Found widget " << widget << " under key "
             << i.key();
}

Если вы хотите удалять элементы во время перебора карты, используйте remove(). Если вы хотите изменить значение элемента, используйте setValue().

Пример:

QMutableMapIterator<QString, QString> i(map);
while (i.hasNext()) {
    i.next();
    if (i.key() == i.value())
        i.remove();
}

В примере удаляются все пары (ключ, значение), где ключ и значение совпадают.

Только один изменяемый итератор может быть активен для данной карты в любой момент. Кроме того, во время активности итератора не следует производить изменения непосредственно в карте (в отличие от использования итератора), поскольку это может сделать итератор недействительным и привести к неопределенному поведению.

См. также QMapIterator и QMap::iterator.

Документация по членам-функциям

void QMutableMapIterator::setValue(const T &value)

Заменяет значение последнего обработанного элемента с помощью одной из функций перехода на значение value.

Функции перехода — next(), previous(), findNext() и findPrevious().

См. также key(), value() и remove().

void QMutableMapIterator::remove()

Удаляет последний обработанный элемент, используя одну из функций перехода (next(), previous(), findNext(), findPrevious()).

См. также setValue().

bool QMutableMapIterator::findPrevious(const T &value)

Ищет value, начиная с текущей позиции итератора в обратном направлении. Возвращает true если пара (ключ, значение) со значением value найдена; в противном случае возвращает false.

После вызова, если value была найдена, итератор позиционируется перед соответствующим элементом; в противном случае итератор позиционируется в начале контейнера.

См. также findNext().

bool QMutableMapIterator::findNext(const T &value)

Ищет value, начиная с текущей позиции итератора в прямом направлении. Возвращает true если пара (ключ, значение) со значением value найдена; в противном случае возвращает false.

После вызова, если value была найдена, итератор позиционируется сразу после соответствующего элемента; в противном случае итератор позиционируется в конце контейнера.

См. также findPrevious().

const Key &QMutableMapIterator::key() const

Возвращает ключ последнего обработанного элемента с помощью одной из функций перехода (next(), previous(), findNext(), findPrevious()).

После вызова next() или findNext(), key() эквивалентно peekPrevious().key(). После вызова previous() или findPrevious(), key() эквивалентно peekNext().key().

См. также value().

T &QMutableMapIterator::value()

Это перегруженная функция.

Возвращает ссылку (без модификатора const) на значение последнего обработанного элемента с помощью одной из функций перехода.

const T &QMutableMapIterator::value() const

Возвращает значение последнего обработанного элемента с помощью одной из функций перехода (next(), previous(), findNext(), findPrevious()).

После вызова next() или findNext(), value() эквивалентно peekPrevious().value(). После вызова previous() или findPrevious(), value() эквивалентно peekNext().value().

См. также key() и setValue().

QMutableMapIterator::Item QMutableMapIterator::peekPrevious() const

Возвращает предыдущий элемент без перемещения итератора.

Вызовите key() на возвращаемом значении, чтобы получить ключ элемента, и value(), чтобы получить значение.

Вызов этой функции для итератора, расположенного в начале контейнера, приводит к неопределённым результатам.

См. также hasPrevious(), previous() и peekNext().

QMutableMapIterator::Item QMutableMapIterator::previous()

Возвращает предыдущий элемент и перемещает итератор назад на одну позицию.

Вызовите key() на возвращаемом значении, чтобы получить ключ элемента, и value(), чтобы получить значение.

Вызов этой функции для итератора, расположенного в начале контейнера, приводит к неопределённым результатам.

См. также hasPrevious(), peekPrevious() и next().

bool QMutableMapIterator::hasPrevious() const

Возвращает true если за итератором есть хотя бы один элемент, т.е. итератор не находится в начале контейнера; в противном случае возвращает false.

См. также hasNext() и previous().

QMutableMapIterator::Item QMutableMapIterator::peekNext() const

Возвращает ссылку на следующий элемент без перемещения итератора.

Вызовите key() на возвращаемом значении, чтобы получить ключ элемента, и value(), чтобы получить значение.

Вызов этой функции для итератора, расположенного в конце контейнера, приводит к неопределённым результатам.

См. также hasNext(), next() и peekPrevious().

QMutableMapIterator::Item QMutableMapIterator::next()

Возвращает следующий элемент и продвигает итератор на одну позицию.

Вызовите key() на возвращаемом значении, чтобы получить ключ элемента, и value() чтобы получить значение.

Вызов этой функции для итератора, расположенного в конце контейнера, приводит к неопределённым результатам.

См. также hasNext(), peekNext() и previous().

bool QMutableMapIterator::hasNext() const

Возвращает true если перед итератором есть хотя бы один элемент, т.е. итератор не находится в конце контейнера; в противном случае возвращает false.

См. также hasPrevious() и next().

void QMutableMapIterator::toBack()

Перемещает итератор в конец контейнера (после последнего элемента).

См. также toFront() и previous().

void QMutableMapIterator::toFront()

Перемещает итератор в начало контейнера (перед первым элементом).

См. также toBack() и next().

QMutableMapIterator<Key, T> &QMutableMapIterator::operator=(QMap<Key, T> &container)

Устанавливает итератор для работы с map. Итератор устанавливается в начало map (перед первым элементом).

См. также toFront() и toBack().

QMutableMapIterator::QMutableMapIterator(QMap<Key, T> &map)

Создаёт итератор для обхода map. Итератор устанавливается в начало map (перед первым элементом).

См. также operator=().