qmapconstiterator(3qt)

1QMapConstIterator(3qt)                                  QMapConstIterator(3qt)
2
3
4

NAME

6       QMapConstIterator - Iterator for QMap
7

SYNOPSIS

9       #include <qmap.h>
10
11   Public Members
12       typedef std::bidirectional_iterator_tag iterator_category
13       typedef T value_type
14       typedef const T * pointer
15       typedef const T & reference
16       QMapConstIterator ()
17       QMapConstIterator ( QMapNode<K, T> * p )
18       QMapConstIterator ( const QMapConstIterator<K, T> & it )
19       QMapConstIterator ( const QMapIterator<K, T> & it )
20       bool operator== ( const QMapConstIterator<K, T> & it ) const
21       bool operator!= ( const QMapConstIterator<K, T> & it ) const
22       const T & operator* () const
23       const K & key () const
24       const T & data () const
25       QMapConstIterator<K, T> & operator++ ()
26       QMapConstIterator<K, T> operator++ ( int )
27       QMapConstIterator<K, T> & operator-- ()
28       QMapConstIterator<K, T> operator-- ( int )
29

DESCRIPTION

31       The QMapConstIterator class provides an iterator for QMap.
32
33       In contrast to QMapIterator, this class is used to iterate over a const
34       map. It does not allow you to modify the values of the map because this
35       would break the const semantics.
36
37       For more information on QMap iterators, see QMapIterator and the QMap
38       example.
39
40       See also QMap, QMapIterator, Qt Template Library Classes, and Non-GUI
41       Classes.
42
43   Member Type Documentation

QMapConstIterator::iterator_category

45       The type of iterator category, std::bidirectional_iterator_tag.
46

QMapConstIterator::pointer

48       Const pointer to value_type.
49

QMapConstIterator::reference

51       Const reference to value_type.
52

QMapConstIterator::value_type

54       The type of const value.
55

MEMBER FUNCTION DOCUMENTATION

QMapConstIterator::QMapConstIterator ()

58       Constructs an uninitialized iterator.
59

QMapConstIterator::QMapConstIterator ( QMapNode<K, T> * p )

61       Constructs an iterator starting at node p.
62

QMapConstIterator::QMapConstIterator ( const QMapConstIterator<K, T> & it )

64       Constructs a copy of the iterator, it.
65

QMapConstIterator::QMapConstIterator ( const QMapIterator<K, T> & it )

67       Constructs a copy of the iterator, it.
68

const T & QMapConstIterator::data () const

70       Returns a const reference to the current item's data.
71

const K & QMapConstIterator::key () const

73       Returns a const reference to the current item's key.
74

bool QMapConstIterator::operator!= ( const QMapConstIterator<K, T> & it )

76       const
77       Compares the iterator to the it iterator and returns FALSE if they
78       point to the same item; otherwise returns TRUE.
79

const T & QMapConstIterator::operator* () const

81       Dereference operator. Returns a const reference to the current item's
82       data. The same as data().
83

QMapConstIterator<K, T> & QMapConstIterator::operator++ ()

85       Prefix ++ makes the succeeding item current and returns an iterator
86       pointing to the new current item. The iterator cannot check whether it
87       reached the end of the map. Incrementing the iterator returned by end()
88       causes undefined results.
89

QMapConstIterator<K, T> QMapConstIterator::operator++ ( int )

91       This is an overloaded member function, provided for convenience. It
92       behaves essentially like the above function.
93
94       Postfix ++ makes the succeeding item current and returns an iterator
95       pointing to the new current item. The iterator cannot check whether it
96       reached the end of the map. Incrementing the iterator returned by end()
97       causes undefined results.
98

QMapConstIterator<K, T> & QMapConstIterator::operator-- ()

100       Prefix -- makes the previous item current and returns an iterator
101       pointing to the new current item. The iterator cannot check whether it
102       reached the beginning of the map. Decrementing the iterator returned by
103       begin() causes undefined results.
104

QMapConstIterator<K, T> QMapConstIterator::operator-- ( int )

106       This is an overloaded member function, provided for convenience. It
107       behaves essentially like the above function.
108
109       Postfix -- makes the previous item current and returns an iterator
110       pointing to the new current item. The iterator cannot check whether it
111       reached the beginning of the map. Decrementing the iterator returned by
112       begin() causes undefined results.
113

bool QMapConstIterator::operator== ( const QMapConstIterator<K, T> & it )

115       const
116       Compares the iterator to the it iterator and returns TRUE if they point
117       to the same item; otherwise returns FALSE.
118
119

COPYRIGHT

125       Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the
126       license file included in the distribution for a complete license
127       statement.
128

AUTHOR

130       Generated automatically from the source code.
131

BUGS

133       If you find a bug in Qt, please report it as described in
134       http://doc.trolltech.com/bughowto.html.  Good bug reports help us to
135       help you. Thank you.
136
137       The definitive Qt documentation is provided in HTML format; it is
138       located at $QTDIR/doc/html and can be read using Qt Assistant or with a
139       web browser. This man page is provided as a convenience for those users
140       who prefer man pages, although this format is not officially supported
141       by Trolltech.
142
143       If you find errors in this manual page, please report them to qt-
144       bugs@trolltech.com.  Please include the name of the manual page
145       (qmapconstiterator.3qt) and the Qt version (3.3.8).
146
147
148
149Trolltech AS                    2 February 2007         QMapConstIterator(3qt)