summaryrefslogtreecommitdiffstats
path: root/src/corelib/tools/qiterator.qdoc
blob: 1ba5b66318e1d167b1031280f3fb9a8e4b574c5b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*! \class QKeyValueIterator
    \inmodule QtCore
    \since 5.10

    \brief Iterator over the key/value pairs of an associative container.

    The QKeyValueIterator class provides an STL-style iterator for returning
    key/value pairs from associative containers like QHash and QMap. It
    supports the same API as the STL associative containers, i.e. getting a
    key/value pair when iterating through the container.

    This will allow for better interoperability between QMap, QHash and friends
    and STL-style algorithms.

    \warning Iterators on implicitly shared containers do not work
    exactly like STL-iterators. You should avoid copying a container
    while iterators are active on that container. For more information,
    read \l{Implicit sharing iterator problem}.
*/

/*! \typedef QKeyValueIterator::iterator_category
    \internal
*/

/*! \typedef QKeyValueIterator::difference_type
    \internal
*/

/*! \typedef QKeyValueIterator::value_type
    \internal
*/

/*! \struct QKeyValueIterator::pointer
    \internal
*/

/*! \typedef QKeyValueIterator::reference
    \internal
*/

/*! \fn template<typename Key, typename T, class Iterator> QKeyValueIterator<Key, T, Iterator>::QKeyValueIterator()

    Constructs a default QKeyValueIterator.
*/

/*! \fn template<typename Key, typename T, class Iterator> QKeyValueIterator<Key, T, Iterator>::QKeyValueIterator(Iterator o)

    Constructs a QKeyValueIterator on top of \a o.
*/

/*! \fn template<typename Key, typename T, class Iterator> std::pair<Key, T> QKeyValueIterator<Key, T, Iterator>::operator*() const

    Returns the current entry as a pair.
*/

/*! \fn template<typename Key, typename T, class Iterator> pointer QKeyValueIterator<Key, T, Iterator>::operator->() const

    Returns the current entry as a pointer-like object to the pair.

    \since 5.15

    \sa operator*()
*/

/*! \fn template<typename Key, typename T, class Iterator> bool QKeyValueIterator<Key, T, Iterator>::operator==(QKeyValueIterator<Key, T, Iterator> lhs, QKeyValueIterator<Key, T, Iterator> rhs)

    Returns \c true if \a rhs points to the same item as \a lhs otherwise returns
    \c false.

    \sa operator!=()
*/

/*! \fn template<typename Key, typename T, class Iterator> bool QKeyValueIterator<Key, T, Iterator>::operator!=(QKeyValueIterator<Key, T, Iterator> lhs, QKeyValueIterator<Key, T, Iterator> rhs)

    Returns \c true if \a rhs points to a different item than \a lhs otherwise
    returns \c false.

    \sa operator==()
*/

/*!
    \fn template<typename Key, typename T, class Iterator> QKeyValueIterator &QKeyValueIterator<Key, T, Iterator>::operator++()

    The prefix ++ operator (\c{++i}) advances the iterator to the
    next item in the container and returns the iterator.

    \note Advancing the iterator past its container's end() constitutes
    undefined behavior.

    \sa operator--()
*/

/*! \fn template<typename Key, typename T, class Iterator> QKeyValueIterator QKeyValueIterator<Key, T, Iterator>::operator++(int)

    \overload

    The postfix ++ operator (\c{i++}) advances the iterator to the
    next item in the container and returns the iterator's prior value.

    \note Advancing the iterator past its container's end() constitutes
    undefined behavior.
*/

/*! \fn template<typename Key, typename T, class Iterator> QKeyValueIterator &QKeyValueIterator<Key, T, Iterator>::operator--()

    The prefix -- operator (\c{--i}) backs the iterator up to the previous item
    in the container and returns the iterator.

    \note Backing up an iterator to before its container's begin() constitutes
    undefined behavior.

    \sa operator++()
*/

/*! \fn template<typename Key, typename T, class Iterator> QKeyValueIterator QKeyValueIterator<Key, T, Iterator>::operator--(int)

    \overload

    The postfix -- operator (\c{i--}) backs the iterator up to the previous item
    in the container and returns the iterator's prior value.

    \note Backing up an iterator to before its container's begin() constitutes
    undefined behavior.
*/

/*! \fn template<typename Key, typename T, class Iterator> Iterator QKeyValueIterator<Key, T, Iterator>::base() const
    Returns the underlying iterator this QKeyValueIterator is based on.
*/

/*!
    \class QListIterator
    \inmodule QtCore

    \brief The QListIterator class provides a Java-style const iterator for QList and QQueue.

    QList has both \l{Java-style iterators} and \l{STL-style
    iterators}. STL-style iterators are more efficient and should
    be preferred.

    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, modify, and remove items without
    using iterators.

    QListIterator\<T\> allows you to iterate over a QList\<T\>,
    a QQueue\<T\> or a QStack\<T\>. If you want to modify the list
    as you iterate over it, use QMutableListIterator\<T\> instead.

    The QListIterator 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:

    \snippet code/doc_src_qiterator.cpp 0

    The next() function returns the next item in the list and
    advances the iterator. Unlike STL-style iterators, Java-style
    iterators point \e between items rather than directly \e 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, and returns the second
    item; and so on.

    \image javaiterators1.png

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

    \snippet code/doc_src_qiterator.cpp 1

    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 list. If the list is
    modified while a QListIterator is active, the QListIterator will
    continue iterating over the original list, ignoring the modified
    copy.

    \sa QMutableListIterator, QList::const_iterator
*/

/*!
    \class QSetIterator
    \inmodule QtCore
    \brief The QSetIterator class provides a Java-style const iterator for QSet.

    QSet has both \l{Java-style iterators} and \l{STL-style
    iterators}. STL-style iterators are more efficient and should
    be preferred.

    QSetIterator\<T\> allows you to iterate over a QSet\<T\>. If you
    want to modify the set as you iterate over it, use
    QMutableSetIterator\<T\> instead.

    The 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:

    \snippet code/doc_src_qiterator.cpp 6

    The next() function returns the next item in the set and
    advances the iterator. Unlike STL-style iterators, Java-style
    iterators point \e between items rather than directly \e 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.

    \image javaiterators1.png

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

    \snippet code/doc_src_qiterator.cpp 7

    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 set. If the set
    is modified while a QSetIterator is active, the QSetIterator
    will continue iterating over the original set, ignoring the
    modified copy.

    \sa QMutableSetIterator, QSet::const_iterator
*/

/*!
    \class QMutableListIterator
    \inmodule QtCore

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

    QList has both \l{Java-style iterators} and \l{STL-style
    iterators}. STL-style iterators are more efficient and should
    be preferred.

    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:

    \snippet code/doc_src_qiterator.cpp 8

    The next() function returns the next item in the list and
    advances the iterator. Unlike STL-style iterators, Java-style
    iterators point \e between items rather than directly \e 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.

    \image javaiterators1.png

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

    \snippet code/doc_src_qiterator.cpp 9

    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:
    \snippet code/doc_src_qiterator.cpp 10

    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.

    \sa QListIterator, QList::iterator
*/

/*!
    \class QMutableSetIterator
    \inmodule QtCore
    \since 4.2

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

    QSet has both \l{Java-style iterators} and \l{STL-style
    iterators}. STL-style iterators are more efficient and should
    be preferred.

    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:

    \snippet code/doc_src_qiterator.cpp 17

    The next() function returns the next item in the set and
    advances the iterator. Unlike STL-style iterators, Java-style
    iterators point \e between items rather than directly \e 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.

    \image javaiterators1.png

    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.

    \sa QSetIterator, QSet::iterator
*/

/*!
    \fn template <class T> QListIterator<T>::QListIterator(const QList<T> &list)
    \fn template <class T> QMutableListIterator<T>::QMutableListIterator(QList<T> &list)

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

    \sa operator=()
*/

/*!
    \fn template <class T> QSetIterator<T>::QSetIterator(const QSet<T> &set)
    \fn template <class T> QMutableSetIterator<T>::QMutableSetIterator(QSet<T> &set)

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

    \sa operator=()
*/

/*! \fn template <class T> QMutableListIterator &QMutableListIterator<T>::operator=(QList<T> &list)
    \fn template <class T> QListIterator &QListIterator<T>::operator=(const QList<T> &list)

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

    \sa toFront(), toBack()
*/

/*! \fn template <class T> QSetIterator &QSetIterator<T>::operator=(const QSet<T> &set)
    \fn template <class T> QMutableSetIterator &QMutableSetIterator<T>::operator=(QSet<T> &set)

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

    \sa toFront(), toBack()
*/

/*! \fn template <class T> void QListIterator<T>::toFront()
    \fn template <class T> void QSetIterator<T>::toFront()
    \fn template <class T> void QMutableListIterator<T>::toFront()
    \fn template <class T> void QMutableSetIterator<T>::toFront()

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

    \sa toBack(), next()
*/

/*! \fn template <class T> void QListIterator<T>::toBack()
    \fn template <class T> void QSetIterator<T>::toBack()
    \fn template <class T> void QMutableListIterator<T>::toBack()

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

    \sa toFront(), previous()
*/

/*! \fn template <class T> void QMutableSetIterator<T>::toBack()

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

    \sa toFront()
*/

/*! \fn template <class T> bool QListIterator<T>::hasNext() const
    \fn template <class T> bool QSetIterator<T>::hasNext() const
    \fn template <class T> bool QMutableListIterator<T>::hasNext() const

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

    \sa hasPrevious(), next()
*/

/*! \fn template <class T> bool QMutableSetIterator<T>::hasNext() const

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

    \sa next()
*/

/*! \fn template <class T> const T &QListIterator<T>::next()
    \fn template <class T> const T &QSetIterator<T>::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.

    \sa hasNext(), peekNext(), previous()
*/

/* \fn template <class T> const T &QMutableSetIterator<T>::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.

    \sa hasNext(), peekNext()
*/

/*! \fn template <class T> const T &QMutableSetIterator<T>::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.

    \sa hasNext(), peekNext()
*/

/*! \fn template <class T> T &QMutableListIterator<T>::next()

    Returns a reference to 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.

    \sa hasNext(), peekNext(), previous()
*/

/*! \fn template <class T> const T &QListIterator<T>::peekNext() const
    \fn template <class T> const T &QSetIterator<T>::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.

    \sa hasNext(), next(), peekPrevious()
*/

/*!
    \fn template <class T> const T &QMutableSetIterator<T>::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.

    \sa hasNext(), next()
*/

/*! \fn template <class T> T &QMutableListIterator<T>::peekNext() const

    Returns a reference to the next item, without moving the iterator.

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

    \sa hasNext(), next(), peekPrevious()
*/

/*! \fn template <class T> bool QListIterator<T>::hasPrevious() const
    \fn template <class T> bool QSetIterator<T>::hasPrevious() const
    \fn template <class T> bool QMutableListIterator<T>::hasPrevious() const

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

    \sa hasNext(), previous()
*/

/*! \fn template <class T> const T &QListIterator<T>::previous()
    \fn template <class T> const T &QSetIterator<T>::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.

    \sa hasPrevious(), peekPrevious(), next()
*/

/*! \fn template <class T> T &QMutableListIterator<T>::previous()

    Returns a reference to 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.

    \sa hasPrevious(), peekPrevious(), next()
*/

/*! \fn template <class T> const T &QListIterator<T>::peekPrevious() const
    \fn template <class T> const T &QSetIterator<T>::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.

    \sa hasPrevious(), previous(), peekNext()
*/

/*! \fn template <class T> T &QMutableListIterator<T>::peekPrevious() const

    Returns a reference to the previous item, without moving the iterator.

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

    \sa hasPrevious(), previous(), peekNext()
*/

/*!
    \fn template <class T> bool QMutableSetIterator<T>::findNext(const T &value)

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

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

/*! \fn template <class T> bool QListIterator<T>::findNext(const T &value)
    \fn template <class T> bool QSetIterator<T>::findNext(const T &value)
    \fn template <class T> bool QMutableListIterator<T>::findNext(const T &value)

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

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

    \sa findPrevious()
*/

/*! \fn template <class T> bool QListIterator<T>::findPrevious(const T &value)
    \fn template <class T> bool QSetIterator<T>::findPrevious(const T &value)
    \fn template <class T> bool QMutableListIterator<T>::findPrevious(const T &value)

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

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

    \sa findNext()
*/

/*! \fn template <class T> void QMutableListIterator<T>::remove()

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

    Example:
    \snippet code/doc_src_qiterator.cpp 19

    \sa insert(), setValue()
*/

/*! \fn template <class T> void QMutableSetIterator<T>::remove()

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

    Example:
    \snippet code/doc_src_qiterator.cpp 22

    \sa value()
*/

/*! \fn template <class T> void QMutableListIterator<T>::setValue(const T &value) const

    Replaces the value of the last item that was jumped over using
    one of the traversal functions with \a value.

    The traversal functions are next(), previous(), findNext(), and
    findPrevious().

    Example:
    \snippet code/doc_src_qiterator.cpp 23

    \sa value(), remove(), insert()
*/

/*! \fn template <class T> const T &QMutableListIterator<T>::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().
*/

/*! \fn template <class T> const T &QMutableSetIterator<T>::value() const

    Returns the value of the last item that was jumped over using
    next() or findNext().
*/

/*!
    \fn template <class T> T &QMutableListIterator<T>::value()
    \overload

    Returns a non-const reference to the value of the last item that
    was jumped over using one of the traversal functions.
*/

/*! \fn template <class T> void QMutableListIterator<T>::insert(const T &value)

    Inserts \a value at the current iterator position. After the
    call, the iterator is located just after the inserted item.

    \sa remove(), setValue()
*/

/*!
    \class QMapIterator
    \inmodule QtCore

    \brief The QMapIterator class provides a Java-style const iterator for QMap.

    QMap has both \l{Java-style iterators} and \l{STL-style
    iterators}. STL-style iterators are more efficient and should
    be preferred.

    QMapIterator\<Key, T\> allows you to iterate over a QMap.
    If you want to modify the map as you iterate over
    it, use QMutableMapIterator instead.

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

    \snippet code/doc_src_qiterator.cpp 26

    The next() function returns the next item in the map and
    advances the iterator. The key() and value() functions return the
    key and value of the last item that was jumped over.

    Unlike STL-style iterators, Java-style iterators point \e between
    items rather than directly \e 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; and so on.

    \image javaiterators1.png

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

    \snippet code/doc_src_qiterator.cpp 27

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

    \snippet code/doc_src_qiterator.cpp 28

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

    \sa QMutableMapIterator, QMap::const_iterator
*/

/*!
    \class QMultiMapIterator
    \inmodule QtCore

    \brief The QMultiMapIterator class provides a Java-style const iterator for QMultiMap.
    QMultiMap has both \l{Java-style iterators} and \l{STL-style
    iterators}. STL-style iterators are more efficient and should
    be preferred.

    QMultiMapIterator\<Key, T\> allows you to iterate over a QMultiMap.
    If you want to modify the map as you iterate over
    it, use QMutableMultiMapIterator instead.

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

    \snippet code/doc_src_qiterator.cpp 26multi

    The next() function returns the next item in the map and
    advances the iterator. The key() and value() functions return the
    key and value of the last item that was jumped over.

    Unlike STL-style iterators, Java-style iterators point \e between
    items rather than directly \e 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; and so on.

    \image javaiterators1.png

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

    \snippet code/doc_src_qiterator.cpp 27multi

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

    \snippet code/doc_src_qiterator.cpp 28multi

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

    \sa QMutableMultiMapIterator
*/

/*!
    \class QHashIterator
    \inmodule QtCore

    \brief The QHashIterator class provides a Java-style const iterator for QHash and QMultiHash.

    QHash has both \l{Java-style iterators} and \l{STL-style
    iterators}. STL-style iterators are more efficient and should
    be preferred.

    QHashIterator\<Key, T\> allows you to iterate over a QHash (or a
    QMultiHash). If you want to modify the hash as you iterate over
    it, use QMutableHashIterator instead.

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

    \snippet code/doc_src_qiterator.cpp 29

    The next() function returns the next item in the hash and
    advances the iterator. The key() and value() functions return the
    key and value of the last item that was jumped over.

    Unlike STL-style iterators, Java-style iterators point \e between
    items rather than directly \e 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; and so on.

    \image javaiterators1.png

    If you want to find all occurrences of a particular value, use
    findNext() in a loop. For example:

    \snippet code/doc_src_qiterator.cpp 31

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

    \sa QMutableHashIterator, QHash::const_iterator
*/

/*!
    \class QMutableMapIterator
    \inmodule QtCore

    \brief The QMutableMapIterator class provides a Java-style non-const iterator for QMap.

    QMap has both \l{Java-style iterators} and \l{STL-style
    iterators}. STL-style iterators are more efficient and should
    be preferred.

    QMutableMapIterator\<Key, T\> allows you to iterate over a QMap
    and modify the map. If you don't want to modify
    the map (or have a const QMap), use the slightly faster
    QMapIterator instead.

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

    \snippet code/doc_src_qiterator.cpp 32

    The next() function returns the next item in the map and
    advances the iterator. The key() and value() functions return the
    key and value of the last item that was jumped over.

    Unlike STL-style iterators, Java-style iterators point \e between
    items rather than directly \e 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; and so on.

    \image javaiterators1.png

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

    \snippet code/doc_src_qiterator.cpp 33

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

    \snippet code/doc_src_qiterator.cpp 34

    If you want to remove items as you iterate over the map, use
    remove(). If you want to modify the value of an item, use
    setValue().

    Example:

    \snippet code/doc_src_qiterator.cpp 35

    The example removes all (key, value) pairs where the key and the
    value are the same.

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

    \sa QMapIterator, QMap::iterator
*/

/*!
    \class QMutableMultiMapIterator
    \inmodule QtCore

    \brief The QMutableMultiMapIterator class provides a Java-style non-const iterator for QMultiMap.

    QMultiMap has both \l{Java-style iterators} and \l{STL-style
    iterators}. STL-style iterators are more efficient and should
    be preferred.

    QMutableMultiMapIterator\<Key, T\> allows you to iterate over a QMultiMap
    and modify the map. If you don't want to modify
    the map (or have a const QMultiMap), use the slightly faster
    QMultiMapIterator instead.

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

    \snippet code/doc_src_qiterator.cpp 32multi

    The next() function returns the next item in the map and
    advances the iterator. The key() and value() functions return the
    key and value of the last item that was jumped over.

    Unlike STL-style iterators, Java-style iterators point \e between
    items rather than directly \e 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; and so on.

    \image javaiterators1.png

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

    \snippet code/doc_src_qiterator.cpp 33multi

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

    \snippet code/doc_src_qiterator.cpp 34multi

    If you want to remove items as you iterate over the map, use
    remove(). If you want to modify the value of an item, use
    setValue().

    Example:

    \snippet code/doc_src_qiterator.cpp 35multi

    The example removes all (key, value) pairs where the key and the
    value are the same.

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

    \sa QMultiMapIterator, QMultiMap::iterator
*/

/*!
    \class QMutableHashIterator
    \inmodule QtCore

    \brief The QMutableHashIterator class provides a Java-style non-const iterator for QHash and QMultiHash.

    QHash has both \l{Java-style iterators} and \l{STL-style
    iterators}. STL-style iterators are more efficient and should
    be preferred.

    QMutableHashIterator\<Key, T\> allows you to iterate over a QHash
    (or a QMultiHash) and modify the hash. If you don't want to modify
    the hash (or have a const QHash), use the slightly faster
    QHashIterator instead.

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

    \snippet code/doc_src_qiterator.cpp 36

    The next() function returns the next item in the hash and
    advances the iterator. The key() and value() functions return the
    key and value of the last item that was jumped over.

    Unlike STL-style iterators, Java-style iterators point \e between
    items rather than directly \e 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; and so on.

    \image javaiterators1.png

    If you want to find all occurrences of a particular value, use
    findNext() in a loop. For example:

    \snippet code/doc_src_qiterator.cpp 38

    If you want to remove items as you iterate over the hash, use
    remove(). If you want to modify the value of an item, use
    setValue().

    Example:

    \snippet code/doc_src_qiterator.cpp 39

    The example removes all (key, value) pairs where the key and the
    value are the same.

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

    \sa QHashIterator, QHash::iterator
*/

/*! \fn template <class Key, class T> QMapIterator<Key, T>::QMapIterator(const QMap<Key, T> &map)
    \fn template <class Key, class T> QMutableMapIterator<Key, T>::QMutableMapIterator(QMap<Key, T> &map)
    \fn template <class Key, class T> QMultiMapIterator<Key, T>::QMultiMapIterator(const QMultiMap<Key, T> &map)
    \fn template <class Key, class T> QMutableMultiMapIterator<Key, T>::QMutableMultiMapIterator(QMultiMap<Key, T> &map)

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

    \sa operator=()
*/

/*! \fn template <class Key, class T> QHashIterator<Key, T>::QHashIterator(const QHash<Key, T> &hash)
    \fn template <class Key, class T> QMutableHashIterator<Key, T>::QMutableHashIterator(QHash<Key, T> &hash)

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

    \sa operator=()
*/

/*! \fn template <class Key, class T> QMapIterator &QMapIterator<Key, T>::operator=(const QMap<Key, T> &map)
    \fn template <class Key, class T> QMutableMapIterator &QMutableMapIterator<Key, T>::operator=(QMap<Key, T> &map)
    \fn template <class Key, class T> QMultiMapIterator &QMultiMapIterator<Key, T>::operator=(const QMultiMap<Key, T> &map)
    \fn template <class Key, class T> QMutableMultiMapIterator &QMutableMultiMapIterator<Key, T>::operator=(QMultiMap<Key, T> &map)

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

    \sa toFront(), toBack()
*/

/*! \fn template <class Key, class T> QHashIterator &QHashIterator<Key, T>::operator=(const QHash<Key, T> &hash)
    \fn template <class Key, class T> QMutableHashIterator &QMutableHashIterator<Key, T>::operator=(QHash<Key, T> &hash)

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

    \sa toFront(), toBack()
*/

/*! \fn template <class Key, class T> void QMapIterator<Key, T>::toFront()
    \fn template <class Key, class T> void QMultiMapIterator<Key, T>::toFront()
    \fn template <class Key, class T> void QHashIterator<Key, T>::toFront()
    \fn template <class Key, class T> void QMutableMapIterator<Key, T>::toFront()
    \fn template <class Key, class T> void QMutableMultiMapIterator<Key, T>::toFront()
    \fn template <class Key, class T> void QMutableHashIterator<Key, T>::toFront()

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

    \sa toBack(), next()
*/

/*! \fn template <class Key, class T> void QMapIterator<Key, T>::toBack()
    \fn template <class Key, class T> void QMultiMapIterator<Key, T>::toBack()
    \fn template <class Key, class T> void QMutableMapIterator<Key, T>::toBack()
    \fn template <class Key, class T> void QMutableMultiMapIterator<Key, T>::toBack()

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

    \sa toFront(), previous()
*/

/*!
    \fn template <class Key, class T> void QHashIterator<Key, T>::toBack()
    \fn template <class Key, class T> void QMutableHashIterator<Key, T>::toBack()

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

    \sa toFront()
*/

/*! \fn template <class Key, class T> bool QMapIterator<Key, T>::hasNext() const
    \fn template <class Key, class T> bool QMultiMapIterator<Key, T>::hasNext() const
    \fn template <class Key, class T> bool QMutableMapIterator<Key, T>::hasNext() const
    \fn template <class Key, class T> bool QMutableMultiMapIterator<Key, T>::hasNext() const

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

    \sa hasPrevious(), next()
*/

/*!
    \fn template <class Key, class T> bool QHashIterator<Key, T>::hasNext() const
    \fn template <class Key, class T> bool QMutableHashIterator<Key, T>::hasNext() const

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

    \sa next()
*/

/*! \fn template <class Key, class T> QMapIterator<Key, T>::Item QMapIterator<Key, T>::next()
    \fn template <class Key, class T> QMultiMapIterator<Key, T>::Item QMultiMapIterator<Key, T>::next()

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

    Call key() on the return value to obtain the item's key, and
    value() to obtain the value.

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

    \sa hasNext(), {QMapIterator::}{peekNext()}, previous()
*/

/*! \fn template <class Key, class T> QMutableMapIterator<Key, T>::Item QMutableMapIterator<Key, T>::next()
    \fn template <class Key, class T> QMutableMultiMapIterator<Key, T>::Item QMutableMultiMapIterator<Key, T>::next()

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

    Call key() on the return value to obtain the item's key, and
    value() to obtain the value.

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

    \sa hasNext(), peekNext(), previous()
*/

/*!
    \fn template <class Key, class T> QHashIterator<Key, T>::Item QHashIterator<Key, T>::next()

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

    Call key() on the return value to obtain the item's key, and
    value() to obtain the value.

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

    \sa hasNext(), peekNext()
*/

/*!
    \fn template <class Key, class T> QMutableHashIterator<Key, T>::Item QMutableHashIterator<Key, T>::next()

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

    Call key() on the return value to obtain the item's key, and
    value() to obtain the value.

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

    \sa hasNext(), peekNext()
*/

/*! \fn template <class Key, class T> QMapIterator<Key, T>::Item QMapIterator<Key, T>::peekNext() const
    \fn template <class Key, class T> QMutableMapIterator<Key, T>::Item QMutableMapIterator<Key, T>::peekNext() const

    Returns the next item without moving the iterator.

    Call key() on the return value to obtain the item's key, and
    value() to obtain the value.

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

    \sa hasNext(), next(), peekPrevious()
*/

/*! \fn template <class Key, class T> QMutableMapIterator<Key, T>::Item QMutableMapIterator<Key, T>::peekNext() const
    \fn template <class Key, class T> QMutableMultiMapIterator<Key, T>::Item QMutableMultiMapIterator<Key, T>::peekNext() const

    Returns a reference to the next item without moving the iterator.

    Call key() on the return value to obtain the item's key, and
    value() to obtain the value.

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

    \sa hasNext(), next(), peekPrevious()
*/

/*!
    \fn template <class Key, class T> QHashIterator<Key, T>::Item QHashIterator<Key, T>::peekNext() const

    Returns the next item without moving the iterator.

    Call key() on the return value to obtain the item's key, and
    value() to obtain the value.

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

    \sa hasNext(), next()
*/

/*!
    \fn template <class Key, class T> QMutableHashIterator<Key, T>::Item QMutableHashIterator<Key, T>::peekNext() const

    Returns a reference to the next item without moving the iterator.

    Call key() on the return value to obtain the item's key, and
    value() to obtain the value.

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

    \sa hasNext(), next()
*/

/*! \fn template <class Key, class T> bool QMapIterator<Key, T>::hasPrevious() const
    \fn template <class Key, class T> bool QMultiMapIterator<Key, T>::hasPrevious() const
    \fn template <class Key, class T> bool QMutableMapIterator<Key, T>::hasPrevious() const
    \fn template <class Key, class T> bool QMutableMultiMapIterator<Key, T>::hasPrevious() const

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

    \sa hasNext(), previous()
*/

/*! \fn template <class Key, class T> QMapIterator<Key, T>::Item QMapIterator<Key, T>::previous()
    \fn template <class Key, class T> QMutableMapIterator<Key, T>::Item QMutableMapIterator<Key, T>::previous()
    \fn template <class Key, class T> QMultiMapIterator<Key, T>::Item QMultiMapIterator<Key, T>::previous()
    \fn template <class Key, class T> QMutableMultiMapIterator<Key, T>::Item QMutableMultiMapIterator<Key, T>::previous()

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

    Call key() on the return value to obtain the item's key, and
    value() to obtain the value.

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

    \sa hasPrevious(), peekPrevious(), next()
*/

/*! \fn template <class Key, class T> QMapIterator<Key, T>::Item QMapIterator<Key, T>::peekPrevious() const
    \fn template <class Key, class T> QMutableMapIterator<Key, T>::Item QMutableMapIterator<Key, T>::peekPrevious() const
    \fn template <class Key, class T> QMultiMapIterator<Key, T>::Item QMultiMapIterator<Key, T>::peekPrevious() const
    \fn template <class Key, class T> QMutableMultiMapIterator<Key, T>::Item QMutableMultiMapIterator<Key, T>::peekPrevious() const

    Returns the previous item without moving the iterator.

    Call key() on the return value to obtain the item's key, and
    value() to obtain the value.

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

    \sa hasPrevious(), previous(), {QMapIterator::}{peekNext()}
*/

/*! \fn template <class Key, class T> const T &QMapIterator<Key, T>::value() const
    \fn template <class Key, class T> const T &QMultiMapIterator<Key, T>::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().value(). After a call to previous()
    or findPrevious(), value() is equivalent to peekNext().value().

    \sa key()
*/

/*!
    \fn template <class Key, class T> const T &QMutableMapIterator<Key, T>::value() const
    \fn template <class Key, class T> const T &QMutableMultiMapIterator<Key, T>::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().value(). After a call to previous()
    or findPrevious(), value() is equivalent to peekNext().value().

    \sa key(), setValue()
*/

/*! \fn template <class Key, class T> const T &QHashIterator<Key, T>::value() const

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

    \sa key()
*/

/*!
    \fn template <class Key, class T> const T &QMutableHashIterator<Key, T>::value() const

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

    \sa key(), setValue()
*/

/*!
    \fn template <class Key, class T> T &QMutableMapIterator<Key, T>::value()
    \fn template <class Key, class T> T &QMutableMultiMapIterator<Key, T>::value()
    \fn template <class Key, class T> T &QMutableHashIterator<Key, T>::value()
    \overload

    Returns a non-const reference to the value of
    the last item that was jumped over using one
    of the traversal functions.
*/

/*! \fn template <class Key, class T> const Key &QMapIterator<Key, T>::key() const
    \fn template <class Key, class T> const Key &QMutableMapIterator<Key, T>::key() const
    \fn template <class Key, class T> const Key &QMultiMapIterator<Key, T>::key() const
    \fn template <class Key, class T> const Key &QMutableMultiMapIterator<Key, T>::key() const

    Returns the key 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(), key() is
    equivalent to peekPrevious().key(). After a call to previous() or
    findPrevious(), key() is equivalent to peekNext().key().

    \sa value()
*/

/*! \fn template <class Key, class T> const Key &QHashIterator<Key, T>::key() const
    \fn template <class Key, class T> const Key &QMutableHashIterator<Key, T>::key() const

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

    \sa value()
*/

/*! \fn template <class Key, class T> bool QMapIterator<Key, T>::findNext(const T &value)
    \fn template <class Key, class T> bool QMutableMapIterator<Key, T>::findNext(const T &value)
    \fn template <class Key, class T> bool QMultiMapIterator<Key, T>::findNext(const T &value)
    \fn template <class Key, class T> bool QMutableMultiMapIterator<Key, T>::findNext(const T &value)

    Searches for \a value starting from the current iterator position
    forward. Returns \c true if a (key, value) pair with value \a value
    is found; otherwise returns \c false.

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

    \sa findPrevious()
*/

/*! \fn template <class Key, class T> bool QHashIterator<Key, T>::findNext(const T &value)
    \fn template <class Key, class T> bool QMutableHashIterator<Key, T>::findNext(const T &value)

    Searches for \a value starting from the current iterator position
    forward. Returns \c true if a (key, value) pair with value \a value
    is found; otherwise returns \c false.

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

/*! \fn template <class Key, class T> bool QMapIterator<Key, T>::findPrevious(const T &value)
    \fn template <class Key, class T> bool QMutableMapIterator<Key, T>::findPrevious(const T &value)
    \fn template <class Key, class T> bool QMultiMapIterator<Key, T>::findPrevious(const T &value)
    \fn template <class Key, class T> bool QMutableMultiMapIterator<Key, T>::findPrevious(const T &value)

    Searches for \a value starting from the current iterator position
    backward. Returns \c true if a (key, value) pair with value \a value
    is found; otherwise returns \c false.

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

    \sa findNext()
*/

/*! \fn template <class Key, class T> void QMutableMapIterator<Key, T>::remove()
    \fn template <class Key, class T> void QMutableMultiMapIterator<Key, T>::remove()

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

    \sa setValue()
*/

/*! \fn template <class Key, class T> void QMutableHashIterator<Key, T>::remove()

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

    \sa setValue()
*/

/*! \fn template <class Key, class T> void QMutableMapIterator<Key, T>::setValue(const T &value)
    \fn template <class Key, class T> void QMutableMultiMapIterator<Key, T>::setValue(const T &value)

    Replaces the value of the last item that was jumped over using
    one of the traversal functions with \a value.

    The traversal functions are next(), previous(), findNext(), and
    findPrevious().

    \sa key(), value(), remove()
*/

/*!
    \fn template <class Key, class T> void QMutableHashIterator<Key, T>::setValue(const T &value)

    Replaces the value of the last item that was jumped over using
    one of the traversal functions with \a value.

    The traversal functions are next() and findNext().

    \sa key(), value(), remove()
*/