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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qlist.cpp -->
<title>Qt 4.8: const_iterator Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtcore.html">QtCore</a></li>
<li>const_iterator</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">const_iterator Class Reference</h1>
<span class="small-subtitle">(QList::const_iterator)<br/></span>
<!-- $$$const_iterator-brief -->
<p>The QList::const_iterator class provides an STL-style const iterator for <a href="qlist.html">QList</a> and <a href="qqueue.html">QQueue</a>. <a href="#details">More...</a></p>
<!-- @@@const_iterator -->
<pre class="cpp"> <span class="preprocessor">#include <<a href="qlist.html">QList</a>></span></pre><ul>
<li><a href="qlist-const-iterator-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#iterator_category-typedef">iterator_category</a></b></td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#const_iterator">const_iterator</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#const_iterator-3">const_iterator</a></b> ( const const_iterator & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#const_iterator-4">const_iterator</a></b> ( const iterator & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator-not-eq">operator!=</a></b> ( const const_iterator & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const T & </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator-2a">operator*</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const_iterator </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator-2b">operator+</a></b> ( int <i>j</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const_iterator & </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator-2b-2b">operator++</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const_iterator </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator-2b-2b-2">operator++</a></b> ( int )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const_iterator & </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator-2b-eq">operator+=</a></b> ( int <i>j</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const_iterator </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator-">operator-</a></b> ( int <i>j</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator--2">operator-</a></b> ( const_iterator <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const_iterator & </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator--">operator--</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const_iterator </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator---2">operator--</a></b> ( int )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const_iterator & </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator--eq">operator-=</a></b> ( int <i>j</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const T * </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator--gt">operator-></a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator-lt">operator<</a></b> ( const const_iterator & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator-lt-eq">operator<=</a></b> ( const const_iterator & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator-eq-eq">operator==</a></b> ( const const_iterator & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator-gt">operator></a></b> ( const const_iterator & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator-gt-eq">operator>=</a></b> ( const const_iterator & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const T & </td><td class="memItemRight bottomAlign"><b><a href="qlist-const-iterator.html#operator-5b-5d">operator[]</a></b> ( int <i>j</i> ) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$const_iterator-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QList::const_iterator class provides an STL-style const iterator for <a href="qlist.html">QList</a> and <a href="qqueue.html">QQueue</a>.</p>
<p><a href="qlist.html">QList</a> provides both <a href="containers.html#stl-style-iterators">STL-style iterators</a> and <a href="containers.html#java-style-iterators">Java-style iterators</a>. The STL-style iterators are more low-level and more cumbersome to use; on the other hand, they are slightly faster and, for developers who already know STL, have the advantage of familiarity.</p>
<p><a href="qlist.html">QList</a><T>::const_iterator allows you to iterate over a <a href="qlist.html">QList</a><T> (or a <a href="qqueue.html">QQueue</a><T>). If you want to modify the <a href="qlist.html">QList</a> as you iterate over it, use <a href="qlist-iterator.html">QList::iterator</a> instead. It is generally good practice to use QList::const_iterator on a non-const <a href="qlist.html">QList</a> as well, unless you need to change the <a href="qlist.html">QList</a> through the iterator. Const iterators are slightly faster, and can improve code readability.</p>
<p>The default QList::const_iterator constructor creates an uninitialized iterator. You must initialize it using a <a href="qlist.html">QList</a> function like <a href="qlist.html#constBegin">QList::constBegin</a>(), <a href="qlist.html#constEnd">QList::constEnd</a>(), or <a href="qlist.html#insert">QList::insert</a>() before you can start iterating. Here's a typical loop that prints all the items stored in a list:</p>
<pre class="cpp"> <span class="type"><a href="qlist.html">QList</a></span><span class="operator"><</span><span class="type"><a href="qstring.html">QString</a></span><span class="operator">></span> list;
list<span class="operator">.</span><a href="qlist.html#append">append</a>(<span class="string">"January"</span>);
list<span class="operator">.</span><a href="qlist.html#append">append</a>(<span class="string">"February"</span>);
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
list<span class="operator">.</span><a href="qlist.html#append">append</a>(<span class="string">"December"</span>);
<span class="type"><a href="qlist.html">QList</a></span><span class="operator"><</span><span class="type"><a href="qstring.html">QString</a></span><span class="operator">></span><span class="operator">::</span>const_iterator i;
<span class="keyword">for</span> (i <span class="operator">=</span> list<span class="operator">.</span>constBegin(); i <span class="operator">!</span><span class="operator">=</span> list<span class="operator">.</span>constEnd(); <span class="operator">+</span><span class="operator">+</span>i)
cout <span class="operator"><</span><span class="operator"><</span> <span class="operator">*</span>i <span class="operator"><</span><span class="operator"><</span> endl;</pre>
<p>Most <a href="qlist.html">QList</a> functions accept an integer index rather than an iterator. For that reason, iterators are rarely useful in connection with <a href="qlist.html">QList</a>. One place where STL-style iterators do make sense is as arguments to <a href="qtalgorithms.html">generic algorithms</a>.</p>
<p>For example, here's how to delete all the widgets stored in a <a href="qlist.html">QList</a><<a href="qwidget.html">QWidget</a> *>:</p>
<pre class="cpp"> <span class="type"><a href="qlist.html">QList</a></span><span class="operator"><</span><span class="type"><a href="qwidget.html">QWidget</a></span> <span class="operator">*</span><span class="operator">></span> list;
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
<a href="qtalgorithms.html#qDeleteAll">qDeleteAll</a>(list<span class="operator">.</span>constBegin()<span class="operator">,</span> list<span class="operator">.</span>constEnd());</pre>
<p>Multiple iterators can be used on the same list. However, be aware that any non-const function call performed on the <a href="qlist.html">QList</a> will render all existing iterators undefined. If you need to keep iterators over a long period of time, we recommend that you use <a href="qlinkedlist.html">QLinkedList</a> rather than <a href="qlist.html">QList</a>.</p>
</div>
<p><b>See also </b><a href="qlist-iterator.html">QList::iterator</a> and <a href="qlistiterator.html">QListIterator</a>.</p>
<!-- @@@const_iterator -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$iterator_category -->
<h3 class="fn"><a name="iterator_category-typedef"></a>typedef const_iterator::<span class="name">iterator_category</span></h3>
<p>A synonym for <i>std::random_access_iterator_tag</i> indicating this iterator is a random access iterator.</p>
<!-- @@@iterator_category -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$const_iterator[overload1]$$$const_iterator -->
<h3 class="fn"><a name="const_iterator"></a>const_iterator::<span class="name">const_iterator</span> ()</h3>
<p>Constructs an uninitialized iterator.</p>
<p>Functions like operator*() and operator++() should not be called on an uninitialized iterator. Use operator=() to assign a value to it before using it.</p>
<p><b>See also </b><a href="qlist.html#constBegin">QList::constBegin</a>() and <a href="qlist.html#constEnd">QList::constEnd</a>().</p>
<!-- @@@const_iterator -->
<!-- $$$const_iterator$$$const_iteratorconstconst_iterator& -->
<h3 class="fn"><a name="const_iterator-3"></a>const_iterator::<span class="name">const_iterator</span> ( const <span class="type">const_iterator</span> & <i>other</i> )</h3>
<p>Constructs a copy of <i>other</i>.</p>
<!-- @@@const_iterator -->
<!-- $$$const_iterator$$$const_iteratorconstiterator& -->
<h3 class="fn"><a name="const_iterator-4"></a>const_iterator::<span class="name">const_iterator</span> ( const <span class="type"><a href="qlist-iterator.html">iterator</a></span> & <i>other</i> )</h3>
<p>Constructs a copy of <i>other</i>.</p>
<!-- @@@const_iterator -->
<!-- $$$operator!=[overload1]$$$operator!=constconst_iterator& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> const_iterator::<span class="name">operator!=</span> ( const <span class="type">const_iterator</span> & <i>other</i> ) const</h3>
<p>Returns true if <i>other</i> points to a different item than this iterator; otherwise returns false.</p>
<p><b>See also </b><a href="qlist-const-iterator.html#operator-eq-eq">operator==</a>().</p>
<!-- @@@operator!= -->
<!-- $$$operator*[overload1]$$$operator* -->
<h3 class="fn"><a name="operator-2a"></a>const <span class="type">T</span> & const_iterator::<span class="name">operator*</span> () const</h3>
<p>Returns the current item.</p>
<p><b>See also </b><a href="qlist-const-iterator.html#operator--gt">operator-></a>().</p>
<!-- @@@operator* -->
<!-- $$$operator+[overload1]$$$operator+int -->
<h3 class="fn"><a name="operator-2b"></a><span class="type">const_iterator</span> const_iterator::<span class="name">operator+</span> ( <span class="type">int</span> <i>j</i> ) const</h3>
<p>Returns an iterator to the item at <i>j</i> positions forward from this iterator. (If <i>j</i> is negative, the iterator goes backward.)</p>
<p><b>See also </b><a href="qlist-const-iterator.html#operator-">operator-</a>() and <a href="qlist-const-iterator.html#operator-2b-eq">operator+=</a>().</p>
<!-- @@@operator+ -->
<!-- $$$operator++[overload1]$$$operator++ -->
<h3 class="fn"><a name="operator-2b-2b"></a><span class="type">const_iterator</span> & const_iterator::<span class="name">operator++</span> ()</h3>
<p>The prefix ++ operator (<tt>++it</tt>) advances the iterator to the next item in the list and returns an iterator to the new current item.</p>
<p>Calling this function on <a href="qlist.html#end">QList::end</a>() leads to undefined results.</p>
<p><b>See also </b><a href="qlist-const-iterator.html#operator--">operator--</a>().</p>
<!-- @@@operator++ -->
<!-- $$$operator++$$$operator++int -->
<h3 class="fn"><a name="operator-2b-2b-2"></a><span class="type">const_iterator</span> const_iterator::<span class="name">operator++</span> ( <span class="type">int</span> )</h3>
<p>This is an overloaded function.</p>
<p>The postfix ++ operator (<tt>it++</tt>) advances the iterator to the next item in the list and returns an iterator to the previously current item.</p>
<!-- @@@operator++ -->
<!-- $$$operator+=[overload1]$$$operator+=int -->
<h3 class="fn"><a name="operator-2b-eq"></a><span class="type">const_iterator</span> & const_iterator::<span class="name">operator+=</span> ( <span class="type">int</span> <i>j</i> )</h3>
<p>Advances the iterator by <i>j</i> items. (If <i>j</i> is negative, the iterator goes backward.)</p>
<p><b>See also </b><a href="qlist-const-iterator.html#operator--eq">operator-=</a>() and <a href="qlist-const-iterator.html#operator-2b">operator+</a>().</p>
<!-- @@@operator+= -->
<!-- $$$operator-[overload1]$$$operator-int -->
<h3 class="fn"><a name="operator-"></a><span class="type">const_iterator</span> const_iterator::<span class="name">operator-</span> ( <span class="type">int</span> <i>j</i> ) const</h3>
<p>Returns an iterator to the item at <i>j</i> positions backward from this iterator. (If <i>j</i> is negative, the iterator goes forward.)</p>
<p><b>See also </b><a href="qlist-const-iterator.html#operator-2b">operator+</a>() and <a href="qlist-const-iterator.html#operator--eq">operator-=</a>().</p>
<!-- @@@operator- -->
<!-- $$$operator-$$$operator-const_iterator -->
<h3 class="fn"><a name="operator--2"></a><span class="type">int</span> const_iterator::<span class="name">operator-</span> ( <span class="type">const_iterator</span> <i>other</i> ) const</h3>
<p>Returns the number of items between the item pointed to by <i>other</i> and the item pointed to by this iterator.</p>
<!-- @@@operator- -->
<!-- $$$operator--[overload1]$$$operator-- -->
<h3 class="fn"><a name="operator--"></a><span class="type">const_iterator</span> & const_iterator::<span class="name">operator--</span> ()</h3>
<p>The prefix -- operator (<tt>--it</tt>) makes the preceding item current and returns an iterator to the new current item.</p>
<p>Calling this function on <a href="qlist.html#begin">QList::begin</a>() leads to undefined results.</p>
<p><b>See also </b><a href="qlist-const-iterator.html#operator-2b-2b">operator++</a>().</p>
<!-- @@@operator-- -->
<!-- $$$operator--$$$operator--int -->
<h3 class="fn"><a name="operator---2"></a><span class="type">const_iterator</span> const_iterator::<span class="name">operator--</span> ( <span class="type">int</span> )</h3>
<p>This is an overloaded function.</p>
<p>The postfix -- operator (<tt>it--</tt>) makes the preceding item current and returns an iterator to the previously current item.</p>
<!-- @@@operator-- -->
<!-- $$$operator-=[overload1]$$$operator-=int -->
<h3 class="fn"><a name="operator--eq"></a><span class="type">const_iterator</span> & const_iterator::<span class="name">operator-=</span> ( <span class="type">int</span> <i>j</i> )</h3>
<p>Makes the iterator go back by <i>j</i> items. (If <i>j</i> is negative, the iterator goes forward.)</p>
<p><b>See also </b><a href="qlist-const-iterator.html#operator-2b-eq">operator+=</a>() and <a href="qlist-const-iterator.html#operator-">operator-</a>().</p>
<!-- @@@operator-= -->
<!-- $$$operator->[overload1]$$$operator-> -->
<h3 class="fn"><a name="operator--gt"></a>const <span class="type">T</span> * const_iterator::<span class="name">operator-></span> () const</h3>
<p>Returns a pointer to the current item.</p>
<p><b>See also </b><a href="qlist-const-iterator.html#operator-2a">operator*</a>().</p>
<!-- @@@operator-> -->
<!-- $$$operator<[overload1]$$$operator<constconst_iterator& -->
<h3 class="fn"><a name="operator-lt"></a><span class="type">bool</span> const_iterator::<span class="name">operator<</span> ( const <span class="type">const_iterator</span> & <i>other</i> ) const</h3>
<p>Returns true if the item pointed to by this iterator is less than the item pointed to by the <i>other</i> iterator.</p>
<!-- @@@operator< -->
<!-- $$$operator<=[overload1]$$$operator<=constconst_iterator& -->
<h3 class="fn"><a name="operator-lt-eq"></a><span class="type">bool</span> const_iterator::<span class="name">operator<=</span> ( const <span class="type">const_iterator</span> & <i>other</i> ) const</h3>
<p>Returns true if the item pointed to by this iterator is less than or equal to the item pointed to by the <i>other</i> iterator.</p>
<!-- @@@operator<= -->
<!-- $$$operator==[overload1]$$$operator==constconst_iterator& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> const_iterator::<span class="name">operator==</span> ( const <span class="type">const_iterator</span> & <i>other</i> ) const</h3>
<p>Returns true if <i>other</i> points to the same item as this iterator; otherwise returns false.</p>
<p><b>See also </b><a href="qlist-const-iterator.html#operator-not-eq">operator!=</a>().</p>
<!-- @@@operator== -->
<!-- $$$operator>[overload1]$$$operator>constconst_iterator& -->
<h3 class="fn"><a name="operator-gt"></a><span class="type">bool</span> const_iterator::<span class="name">operator></span> ( const <span class="type">const_iterator</span> & <i>other</i> ) const</h3>
<p>Returns true if the item pointed to by this iterator is greater than the item pointed to by the <i>other</i> iterator.</p>
<!-- @@@operator> -->
<!-- $$$operator>=[overload1]$$$operator>=constconst_iterator& -->
<h3 class="fn"><a name="operator-gt-eq"></a><span class="type">bool</span> const_iterator::<span class="name">operator>=</span> ( const <span class="type">const_iterator</span> & <i>other</i> ) const</h3>
<p>Returns true if the item pointed to by this iterator is greater than or equal to the item pointed to by the <i>other</i> iterator.</p>
<!-- @@@operator>= -->
<!-- $$$operator[][overload1]$$$operator[]int -->
<h3 class="fn"><a name="operator-5b-5d"></a>const <span class="type">T</span> & const_iterator::<span class="name">operator[]</span> ( <span class="type">int</span> <i>j</i> ) const</h3>
<p>Returns the item at position *this + <i>j</i>.</p>
<p>This function is provided to make <a href="qlist.html">QList</a> iterators behave like C++ pointers.</p>
<p><b>See also </b><a href="qlist-const-iterator.html#operator-2b">operator+</a>().</p>
<!-- @@@operator[] -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>
|