Sophie

Sophie

distrib > Mageia > 6 > armv5tl > media > core-updates > by-pkgid > 768f7d9f703884aa2562bf0a651086df > files > 392

qtbase5-doc-5.9.4-1.1.mga6.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qfuture.qdoc -->
  <title>const_iterator Class | Qt Core 5.9</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.9</td><td ><a href="qtcore-index.html">Qt Core</a></td><td ><a href="qtcore-module.html">C++ Classes</a></td><td >const_iterator</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<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>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">const_iterator Class</h1>
<span class="small-subtitle">(<a href="qfuture-const-iterator.html">QFuture::const_iterator</a>)<br/></span>
<!-- $$$const_iterator-brief -->
<p>The <a href="qfuture-const-iterator.html">QFuture::const_iterator</a> class provides an STL-style const iterator for <a href="qfuture.html">QFuture</a>. <a href="#details">More...</a></p>
<!-- @@@const_iterator -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;<a href="qfuture.html">QFuture</a>&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += core</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 4.4</td></tr></table></div><ul>
<li><a href="qfuture-const-iterator-members.html">List of all members, including inherited members</a></li>
</ul>
<p><b>Note:</b> All functions in this class are reentrant.</p>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qfuture-const-iterator.html#difference_type-typedef">difference_type</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qfuture-const-iterator.html#iterator_category-typedef">iterator_category</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qfuture-const-iterator.html#pointer-typedef">pointer</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qfuture-const-iterator.html#reference-typedef">reference</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qfuture-const-iterator.html#value_type-typedef">value_type</a></b></td></tr>
</table></div>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qfuture-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="qfuture-const-iterator.html#const_iterator-2">const_iterator</a></b>(const const_iterator &amp;<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qfuture-const-iterator.html#operator-not-eq">operator!=</a></b>(const const_iterator &amp;<i>other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const T &amp;</td><td class="memItemRight bottomAlign"><b><a href="qfuture-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="qfuture-const-iterator.html#operator-2b">operator+</a></b>(int <i>j</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const_iterator &amp;</td><td class="memItemRight bottomAlign"><b><a href="qfuture-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="qfuture-const-iterator.html#operator-2b-2b-1">operator++</a></b>(<i>int</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const_iterator &amp;</td><td class="memItemRight bottomAlign"><b><a href="qfuture-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="qfuture-const-iterator.html#operator-">operator-</a></b>(int <i>j</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const_iterator &amp;</td><td class="memItemRight bottomAlign"><b><a href="qfuture-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="qfuture-const-iterator.html#operator---1">operator--</a></b>(<i>int</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const_iterator &amp;</td><td class="memItemRight bottomAlign"><b><a href="qfuture-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="qfuture-const-iterator.html#operator--gt">operator-&gt;</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const_iterator &amp;</td><td class="memItemRight bottomAlign"><b><a href="qfuture-const-iterator.html#operator-eq">operator=</a></b>(const const_iterator &amp;<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qfuture-const-iterator.html#operator-eq-eq">operator==</a></b>(const const_iterator &amp;<i>other</i>) const</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$const_iterator-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qfuture-const-iterator.html">QFuture::const_iterator</a> class provides an STL-style const iterator for <a href="qfuture.html">QFuture</a>.</p>
<p><a href="qfuture.html">QFuture</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>The default <a href="qfuture-const-iterator.html">QFuture::const_iterator</a> constructor creates an uninitialized iterator. You must initialize it using a <a href="qfuture.html">QFuture</a> function like <a href="qfuture.html#constBegin">QFuture::constBegin</a>() or <a href="qfuture.html#constEnd">QFuture::constEnd</a>() before you start iterating. Here's a typical loop that prints all the results available in a future:</p>
<pre class="cpp">

  <span class="type"><a href="qfuture.html#QFuture">QFuture</a></span><span class="operator">&lt;</span><span class="type"><a href="qstring.html">QString</a></span><span class="operator">&gt;</span> future <span class="operator">=</span> <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>;

  <span class="type"><a href="qfuture.html#QFuture">QFuture</a></span><span class="operator">&lt;</span><span class="type"><a href="qstring.html">QString</a></span><span class="operator">&gt;</span><span class="operator">::</span>const_iterator i;
  <span class="keyword">for</span> (i <span class="operator">=</span> future<span class="operator">.</span>constBegin(); i <span class="operator">!</span><span class="operator">=</span> future<span class="operator">.</span>constEnd(); <span class="operator">+</span><span class="operator">+</span>i)
      cout <span class="operator">&lt;</span><span class="operator">&lt;</span> <span class="operator">*</span>i <span class="operator">&lt;</span><span class="operator">&lt;</span> endl;

</pre>
</div>
<p><b>See also </b><a href="qfutureiterator.html">QFutureIterator</a> and <a href="qfuture.html">QFuture</a>.</p>
<!-- @@@const_iterator -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$difference_type -->
<h3 class="fn" id="difference_type-typedef"><a name="difference_type-typedef"></a>typedef const_iterator::<span class="name">difference_type</span></h3>
<p>Typedef for ptrdiff_t. Provided for STL compatibility.</p>
<!-- @@@difference_type -->
<!-- $$$iterator_category -->
<h3 class="fn" id="iterator_category-typedef"><a name="iterator_category-typedef"></a>typedef const_iterator::<span class="name">iterator_category</span></h3>
<p>Typedef for std::bidirectional_iterator_tag. Provided for STL compatibility.</p>
<!-- @@@iterator_category -->
<!-- $$$pointer -->
<h3 class="fn" id="pointer-typedef"><a name="pointer-typedef"></a>typedef const_iterator::<span class="name">pointer</span></h3>
<p>Typedef for const T *. Provided for STL compatibility.</p>
<!-- @@@pointer -->
<!-- $$$reference -->
<h3 class="fn" id="reference-typedef"><a name="reference-typedef"></a>typedef const_iterator::<span class="name">reference</span></h3>
<p>Typedef for const T &amp;. Provided for STL compatibility.</p>
<!-- @@@reference -->
<!-- $$$value_type -->
<h3 class="fn" id="value_type-typedef"><a name="value_type-typedef"></a>typedef const_iterator::<span class="name">value_type</span></h3>
<p>Typedef for T. Provided for STL compatibility.</p>
<!-- @@@value_type -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$const_iterator[overload1]$$$const_iterator -->
<h3 class="fn" id="const_iterator"><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 iterartor. Use operator=() to assign a value to it before using it.</p>
<p><b>See also </b><a href="qfuture.html#constBegin">QFuture::constBegin</a>() and <a href="qfuture.html#constEnd">QFuture::constEnd</a>().</p>
<!-- @@@const_iterator -->
<!-- $$$const_iterator$$$const_iteratorconstconst_iterator& -->
<h3 class="fn" id="const_iterator-2"><a name="const_iterator-2"></a>const_iterator::<span class="name">const_iterator</span>(const <span class="type"><a href="qfuture-const-iterator.html#const_iterator">const_iterator</a></span> &amp;<i>other</i>)</h3>
<p>Constructs a copy of <i>other</i>.</p>
<!-- @@@const_iterator -->
<!-- $$$operator!=[overload1]$$$operator!=constconst_iterator& -->
<h3 class="fn" id="operator-not-eq"><a name="operator-not-eq"></a><span class="type">bool</span> const_iterator::<span class="name">operator!=</span>(const <span class="type"><a href="qfuture-const-iterator.html#const_iterator">const_iterator</a></span> &amp;<i>other</i>) const</h3>
<p>Returns <code>true</code> if <i>other</i> points to a different result than this iterator; otherwise returns <code>false</code>.</p>
<p><b>See also </b><a href="qfuture-const-iterator.html#operator-eq-eq">operator==</a>().</p>
<!-- @@@operator!= -->
<!-- $$$operator*[overload1]$$$operator* -->
<h3 class="fn" id="operator-2a"><a name="operator-2a"></a>const <span class="type">T</span> &amp;const_iterator::<span class="name">operator*</span>() const</h3>
<p>Returns the current result.</p>
<!-- @@@operator* -->
<!-- $$$operator+[overload1]$$$operator+int -->
<h3 class="fn" id="operator-2b"><a name="operator-2b"></a><span class="type"><a href="qfuture-const-iterator.html#const_iterator">const_iterator</a></span> const_iterator::<span class="name">operator+</span>(<span class="type">int</span> <i>j</i>) const</h3>
<p>Returns an iterator to the results 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="qfuture-const-iterator.html#operator-">operator-</a>() and <a href="qfuture-const-iterator.html#operator-2b-eq">operator+=</a>().</p>
<!-- @@@operator+ -->
<!-- $$$operator++[overload1]$$$operator++ -->
<h3 class="fn" id="operator-2b-2b"><a name="operator-2b-2b"></a><span class="type"><a href="qfuture-const-iterator.html#const_iterator">const_iterator</a></span> &amp;const_iterator::<span class="name">operator++</span>()</h3>
<p>The prefix ++ operator (<code>++it</code>) advances the iterator to the next result in the future and returns an iterator to the new current result.</p>
<p>Calling this function on <a href="qfuture.html#constEnd">QFuture::constEnd</a>() leads to undefined results.</p>
<p><b>See also </b><a href="qfuture-const-iterator.html#operator--">operator--</a>().</p>
<!-- @@@operator++ -->
<!-- $$$operator++$$$operator++int -->
<h3 class="fn" id="operator-2b-2b-1"><a name="operator-2b-2b-1"></a><span class="type"><a href="qfuture-const-iterator.html#const_iterator">const_iterator</a></span> const_iterator::<span class="name">operator++</span>(<i>int</i>)</h3>
<p>This is an overloaded function.</p>
<p>The postfix ++ operator (<code>it++</code>) advances the iterator to the next result in the future and returns an iterator to the previously current result.</p>
<!-- @@@operator++ -->
<!-- $$$operator+=[overload1]$$$operator+=int -->
<h3 class="fn" id="operator-2b-eq"><a name="operator-2b-eq"></a><span class="type"><a href="qfuture-const-iterator.html#const_iterator">const_iterator</a></span> &amp;const_iterator::<span class="name">operator+=</span>(<span class="type">int</span> <i>j</i>)</h3>
<p>Advances the iterator by <i>j</i> results. (If <i>j</i> is negative, the iterator goes backward.)</p>
<p><b>See also </b><a href="qfuture-const-iterator.html#operator--eq">operator-=</a>() and <a href="qfuture-const-iterator.html#operator-2b">operator+</a>().</p>
<!-- @@@operator+= -->
<!-- $$$operator-[overload1]$$$operator-int -->
<h3 class="fn" id="operator-"><a name="operator-"></a><span class="type"><a href="qfuture-const-iterator.html#const_iterator">const_iterator</a></span> const_iterator::<span class="name">operator-</span>(<span class="type">int</span> <i>j</i>) const</h3>
<p>Returns an iterator to the result 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="qfuture-const-iterator.html#operator-2b">operator+</a>() and <a href="qfuture-const-iterator.html#operator--eq">operator-=</a>().</p>
<!-- @@@operator- -->
<!-- $$$operator--[overload1]$$$operator-- -->
<h3 class="fn" id="operator--"><a name="operator--"></a><span class="type"><a href="qfuture-const-iterator.html#const_iterator">const_iterator</a></span> &amp;const_iterator::<span class="name">operator--</span>()</h3>
<p>The prefix -- operator (<code>--it</code>) makes the preceding result current and returns an iterator to the new current result.</p>
<p>Calling this function on <a href="qfuture.html#constBegin">QFuture::constBegin</a>() leads to undefined results.</p>
<p><b>See also </b><a href="qfuture-const-iterator.html#operator-2b-2b">operator++</a>().</p>
<!-- @@@operator-- -->
<!-- $$$operator--$$$operator--int -->
<h3 class="fn" id="operator---1"><a name="operator---1"></a><span class="type"><a href="qfuture-const-iterator.html#const_iterator">const_iterator</a></span> const_iterator::<span class="name">operator--</span>(<i>int</i>)</h3>
<p>This is an overloaded function.</p>
<p>The postfix -- operator (<code>it--</code>) makes the preceding result current and returns an iterator to the previously current result.</p>
<!-- @@@operator-- -->
<!-- $$$operator-=[overload1]$$$operator-=int -->
<h3 class="fn" id="operator--eq"><a name="operator--eq"></a><span class="type"><a href="qfuture-const-iterator.html#const_iterator">const_iterator</a></span> &amp;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> results. (If <i>j</i> is negative, the iterator goes forward.)</p>
<p><b>See also </b><a href="qfuture-const-iterator.html#operator-2b-eq">operator+=</a>() and <a href="qfuture-const-iterator.html#operator-">operator-</a>().</p>
<!-- @@@operator-= -->
<!-- $$$operator->[overload1]$$$operator-> -->
<h3 class="fn" id="operator--gt"><a name="operator--gt"></a>const <span class="type">T</span> *const_iterator::<span class="name">operator-&gt;</span>() const</h3>
<p>Returns a pointer to the current result.</p>
<!-- @@@operator-> -->
<!-- $$$operator=[overload1]$$$operator=constconst_iterator& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qfuture-const-iterator.html#const_iterator">const_iterator</a></span> &amp;const_iterator::<span class="name">operator=</span>(const <span class="type"><a href="qfuture-const-iterator.html#const_iterator">const_iterator</a></span> &amp;<i>other</i>)</h3>
<p>Assigns <i>other</i> to this iterator.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constconst_iterator& -->
<h3 class="fn" id="operator-eq-eq"><a name="operator-eq-eq"></a><span class="type">bool</span> const_iterator::<span class="name">operator==</span>(const <span class="type"><a href="qfuture-const-iterator.html#const_iterator">const_iterator</a></span> &amp;<i>other</i>) const</h3>
<p>Returns <code>true</code> if <i>other</i> points to the same result as this iterator; otherwise returns <code>false</code>.</p>
<p><b>See also </b><a href="qfuture-const-iterator.html#operator-not-eq">operator!=</a>().</p>
<!-- @@@operator== -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2017 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br>    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.<br>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>