From bd0f3345a938b35ce6a12f6150373b0955b8dd12 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Sun, 10 Jul 2011 15:24:15 -0500 Subject: Add Qt3 development HEAD version --- doc/html/qmapiterator.html | 196 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 196 insertions(+) create mode 100644 doc/html/qmapiterator.html (limited to 'doc/html/qmapiterator.html') diff --git a/doc/html/qmapiterator.html b/doc/html/qmapiterator.html new file mode 100644 index 0000000..9b36d70 --- /dev/null +++ b/doc/html/qmapiterator.html @@ -0,0 +1,196 @@ + + + + + +QMapIterator Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

QMapIterator Class Reference

+ +

The QMapIterator class provides an iterator for QMap. +More... +

#include <qmap.h> +

List of all member functions. +

Public Members

+ +

Detailed Description

+ + +The QMapIterator class provides an iterator for QMap. +

+ +

You cannot create an iterator by yourself. Instead, you must ask a +map to give you one. An iterator is as big as a pointer; on 32-bit +machines that means 4 bytes, on 64-bit machines, 8 bytes. That +makes copying iterators very fast. Iterators behave in a similar +way to pointers, and they are almost as fast as pointers. See the +QMap example. +

QMap is highly optimized for performance and memory usage, but the +trade-off is that you must be more careful. The only way to +traverse a map is to use iterators. QMap does not know about its +iterators, and the iterators don't even know to which map they +belong. That makes things fast but a bit dangerous because it is +up to you to make sure that the iterators you are using are still +valid. QDictIterator will be able to give warnings, whereas +QMapIterator may end up in an undefined state. +

For every Iterator there is also a ConstIterator. You must use the +ConstIterator to access a QMap in a const environment or if the +reference or pointer to the map is itself const. Its semantics are +the same, but it only returns const references to the item it +points to. +

See also QMap, QMapConstIterator, Qt Template Library Classes, and Non-GUI Classes. + +

Member Type Documentation

+

QMapIterator::iterator_category

+The type of iterator category, std::bidirectional_iterator_tag. +

QMapIterator::pointer

+Pointer to value_type. +

QMapIterator::reference

+Reference to value_type. +

QMapIterator::value_type

+The type of value. +

Member Function Documentation

+

QMapIterator::QMapIterator () +

+ +

Creates an uninitialized iterator. + +

QMapIterator::QMapIterator ( QMapNode<K, T> * p ) +

+ +

Constructs an iterator starting at node p. + +

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

+ +

Constructs a copy of the iterator, it. + +

T & QMapIterator::data () +

+ +

Returns a reference to the current item's data. + +

const T & QMapIterator::data () const +

+ +

This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

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

const K & QMapIterator::key () const +

+ +

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

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

+ +

Compares the iterator to the it iterator and returns FALSE if +they point to the same item; otherwise returns TRUE. + +

T & QMapIterator::operator* () +

+ +

Dereference operator. Returns a reference to the current item's +data. The same as data(). + +

const T & QMapIterator::operator* () const +

+ +

This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

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

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

+ +

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

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

+ +

This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

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

QMapIterator<K, T> & QMapIterator::operator-- () +

+ +

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

QMapIterator<K, T> QMapIterator::operator-- ( int ) +

+ +

This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

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

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

+ +

Compares the iterator to the it iterator and returns TRUE if +they point to the same item; otherwise returns FALSE. + + +

+This file is part of the Qt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
Qt 3.3.8
+
+ -- cgit v1.2.3