diff options
| author | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-07-10 15:24:15 -0500 |
|---|---|---|
| committer | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-07-10 15:24:15 -0500 |
| commit | bd0f3345a938b35ce6a12f6150373b0955b8dd12 (patch) | |
| tree | 7a520322212d48ebcb9fbe1087e7fca28b76185c /doc/html/qmapiterator.html | |
| download | qt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.tar.gz qt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.zip | |
Add Qt3 development HEAD version
Diffstat (limited to 'doc/html/qmapiterator.html')
| -rw-r--r-- | doc/html/qmapiterator.html | 196 |
1 files changed, 196 insertions, 0 deletions
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 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/doc/qmap.doc:604 --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>QMapIterator Class</title> +<style type="text/css"><!-- +fn { margin-left: 1cm; text-indent: -1cm; } +a:link { color: #004faf; text-decoration: none } +a:visited { color: #672967; text-decoration: none } +body { background: #ffffff; color: black; } +--></style> +</head> +<body> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr bgcolor="#E5E5E5"> +<td valign=center> + <a href="index.html"> +<font color="#004faf">Home</font></a> + | <a href="classes.html"> +<font color="#004faf">All Classes</font></a> + | <a href="mainclasses.html"> +<font color="#004faf">Main Classes</font></a> + | <a href="annotated.html"> +<font color="#004faf">Annotated</font></a> + | <a href="groups.html"> +<font color="#004faf">Grouped Classes</font></a> + | <a href="functions.html"> +<font color="#004faf">Functions</font></a> +</td> +<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QMapIterator Class Reference</h1> + +<p>The QMapIterator class provides an iterator for QMap. +<a href="#details">More...</a> +<p><tt>#include <<a href="qmap-h.html">qmap.h</a>></tt> +<p><a href="qmapiterator-members.html">List of all member functions.</a> +<h2>Public Members</h2> +<ul> +<li class=fn>typedef std::bidirectional_iterator_tag <a href="#iterator_category"><b>iterator_category</b></a></li> +<li class=fn>typedef T <a href="#value_type"><b>value_type</b></a></li> +<li class=fn>typedef T * <a href="#pointer"><b>pointer</b></a></li> +<li class=fn>typedef T & <a href="#reference"><b>reference</b></a></li> +<li class=fn><a href="#QMapIterator"><b>QMapIterator</b></a> ()</li> +<li class=fn><a href="#QMapIterator-2"><b>QMapIterator</b></a> ( QMapNode<K, T> * p )</li> +<li class=fn><a href="#QMapIterator-3"><b>QMapIterator</b></a> ( const QMapIterator<K, T> & it )</li> +<li class=fn>bool <a href="#operator-eq-eq"><b>operator==</b></a> ( const QMapIterator<K, T> & it ) const</li> +<li class=fn>bool <a href="#operator!-eq"><b>operator!=</b></a> ( const QMapIterator<K, T> & it ) const</li> +<li class=fn>T & <a href="#operator*"><b>operator*</b></a> ()</li> +<li class=fn>const T & <a href="#operator*-2"><b>operator*</b></a> () const</li> +<li class=fn>const K & <a href="#key"><b>key</b></a> () const</li> +<li class=fn>T & <a href="#data"><b>data</b></a> ()</li> +<li class=fn>const T & <a href="#data-2"><b>data</b></a> () const</li> +<li class=fn>QMapIterator<K, T> & <a href="#operator++"><b>operator++</b></a> ()</li> +<li class=fn>QMapIterator<K, T> <a href="#operator++-2"><b>operator++</b></a> ( int )</li> +<li class=fn>QMapIterator<K, T> & <a href="#operator--"><b>operator--</b></a> ()</li> +<li class=fn>QMapIterator<K, T> <a href="#operator---2"><b>operator--</b></a> ( int )</li> +</ul> +<hr><a name="details"></a><h2>Detailed Description</h2> + + +The QMapIterator class provides an iterator for <a href="qmap.html">QMap</a>. +<p> + +<p> 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 +<a href="qmap.html#qmap-eg">QMap example</a>. +<p> 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. <a href="qdictiterator.html">QDictIterator</a> will be able to give warnings, whereas +QMapIterator may end up in an undefined state. +<p> For every Iterator there is also a ConstIterator. You must use the +ConstIterator to access a <a href="qmap.html">QMap</a> 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. +<p> <p>See also <a href="qmap.html">QMap</a>, <a href="qmapconstiterator.html">QMapConstIterator</a>, <a href="qtl.html">Qt Template Library Classes</a>, and <a href="tools.html">Non-GUI Classes</a>. + +<hr><h2>Member Type Documentation</h2> +<h3 class=fn><a name="iterator_category"></a>QMapIterator::iterator_category</h3> +The type of iterator category, <tt>std::bidirectional_iterator_tag</tt>. +<h3 class=fn><a name="pointer"></a>QMapIterator::pointer</h3> +Pointer to value_type. +<h3 class=fn><a name="reference"></a>QMapIterator::reference</h3> +Reference to value_type. +<h3 class=fn><a name="value_type"></a>QMapIterator::value_type</h3> +The type of value. +<hr><h2>Member Function Documentation</h2> +<h3 class=fn><a name="QMapIterator"></a>QMapIterator::QMapIterator () +</h3> + +<p> Creates an uninitialized iterator. + +<h3 class=fn><a name="QMapIterator-2"></a>QMapIterator::QMapIterator ( QMapNode<K, T> * p ) +</h3> + +<p> Constructs an iterator starting at node <em>p</em>. + +<h3 class=fn><a name="QMapIterator-3"></a>QMapIterator::QMapIterator ( const <a href="qmapiterator.html">QMapIterator</a><K, T> & it ) +</h3> + +<p> Constructs a copy of the iterator, <em>it</em>. + +<h3 class=fn>T & <a name="data"></a>QMapIterator::data () +</h3> + +<p> Returns a reference to the current item's data. + +<h3 class=fn>const T & <a name="data-2"></a>QMapIterator::data () const +</h3> + +<p> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +<p> Returns a const reference to the current item's data. + +<h3 class=fn>const K & <a name="key"></a>QMapIterator::key () const +</h3> + +<p> Returns a const reference to the current item's key. + +<h3 class=fn>bool <a name="operator!-eq"></a>QMapIterator::operator!= ( const <a href="qmapiterator.html">QMapIterator</a><K, T> & it ) const +</h3> + +<p> Compares the iterator to the <em>it</em> iterator and returns FALSE if +they point to the same item; otherwise returns TRUE. + +<h3 class=fn>T & <a name="operator*"></a>QMapIterator::operator* () +</h3> + +<p> Dereference operator. Returns a reference to the current item's +data. The same as <a href="#data">data</a>(). + +<h3 class=fn>const T & <a name="operator*-2"></a>QMapIterator::operator* () const +</h3> + +<p> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +<p> Dereference operator. Returns a const reference to the current +item's data. The same as <a href="#data">data</a>(). + +<h3 class=fn><a href="qmapiterator.html">QMapIterator</a><K, T> & <a name="operator++"></a>QMapIterator::operator++ () +</h3> + +<p> 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. + +<h3 class=fn><a href="qmapiterator.html">QMapIterator</a><K, T> <a name="operator++-2"></a>QMapIterator::operator++ ( int ) +</h3> + +<p> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +<p> 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. + +<h3 class=fn><a href="qmapiterator.html">QMapIterator</a><K, T> & <a name="operator--"></a>QMapIterator::operator-- () +</h3> + +<p> 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. + +<h3 class=fn><a href="qmapiterator.html">QMapIterator</a><K, T> <a name="operator---2"></a>QMapIterator::operator-- ( int ) +</h3> + +<p> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +<p> 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. + +<h3 class=fn>bool <a name="operator-eq-eq"></a>QMapIterator::operator== ( const <a href="qmapiterator.html">QMapIterator</a><K, T> & it ) const +</h3> + +<p> Compares the iterator to the <em>it</em> iterator and returns TRUE if +they point to the same item; otherwise returns FALSE. + +<!-- eof --> +<hr><p> +This file is part of the <a href="index.html">Qt toolkit</a>. +Copyright © 1995-2007 +<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center> +<table width=100% cellspacing=0 border=0><tr> +<td>Copyright © 2007 +<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a> +<td align=right><div align=right>Qt 3.3.8</div> +</table></div></address></body> +</html> |