<?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" /> <!-- qfuture.cpp --> <title>Qt 4.8: QFutureIterator Class Reference</title> <link rel="stylesheet" type="text/css" href="style/style.css" /> <script src="scripts/jquery.js" type="text/javascript"></script> <script src="scripts/functions.js" type="text/javascript"></script> <link rel="stylesheet" type="text/css" href="style/superfish.css" /> <link rel="stylesheet" type="text/css" href="style/narrow.css" /> <!--[if IE]> <meta name="MSSmartTagsPreventParsing" content="true"> <meta http-equiv="imagetoolbar" content="no"> <![endif]--> <!--[if lt IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie6.css"> <![endif]--> <!--[if IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie7.css"> <![endif]--> <!--[if IE 8]> <link rel="stylesheet" type="text/css" href="style/style_ie8.css"> <![endif]--> <script src="scripts/superfish.js" type="text/javascript"></script> <script src="scripts/narrow.js" type="text/javascript"></script> </head> <body class="" onload="CheckEmptyAndLoadList();"> <div class="header" id="qtdocheader"> <div class="content"> <div id="nav-logo"> <a href="index.html">Home</a></div> <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a> <div id="narrowsearch"></div> <div id="nav-topright"> <ul> <li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li> <li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li> <li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/"> DOC</a></li> <li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li> </ul> </div> <div id="shortCut"> <ul> <li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li> <li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li> </ul> </div> <ul class="sf-menu" id="narrowmenu"> <li><a href="#">API Lookup</a> <ul> <li><a href="classes.html">Class index</a></li> <li><a href="functions.html">Function index</a></li> <li><a href="modules.html">Modules</a></li> <li><a href="namespaces.html">Namespaces</a></li> <li><a href="qtglobal.html">Global Declarations</a></li> <li><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </li> <li><a href="#">Qt Topics</a> <ul> <li><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li><a href="supported-platforms.html">Supported Platforms</a></li> <li><a href="technology-apis.html">Qt and Key Technologies</a></li> <li><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </li> <li><a href="#">Examples</a> <ul> <li><a href="all-examples.html">Examples</a></li> <li><a href="tutorials.html">Tutorials</a></li> <li><a href="demos.html">Demos</a></li> <li><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </li> </ul> </div> </div> <div class="wrapper"> <div class="hd"> <span></span> </div> <div class="bd group"> <div class="sidebar"> <div class="searchlabel"> Search index:</div> <div class="search" id="sidebarsearch"> <form id="qtdocsearch" action="" onsubmit="return false;"> <fieldset> <input type="text" name="searchstring" id="pageType" value="" /> <div id="resultdialog"> <a href="#" id="resultclose">Close</a> <p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p> <p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p> <ul id="resultlist" class="all"> </ul> </div> </fieldset> </form> </div> <div class="box first bottombar" id="lookup"> <h2 title="API Lookup"><span></span> API Lookup</h2> <div id="list001" class="list"> <ul id="ul001" > <li class="defaultLink"><a href="classes.html">Class index</a></li> <li class="defaultLink"><a href="functions.html">Function index</a></li> <li class="defaultLink"><a href="modules.html">Modules</a></li> <li class="defaultLink"><a href="namespaces.html">Namespaces</a></li> <li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li> <li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </div> </div> <div class="box bottombar" id="topics"> <h2 title="Qt Topics"><span></span> Qt Topics</h2> <div id="list002" class="list"> <ul id="ul002" > <li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li> <li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li> <li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </div> </div> <div class="box" id="examples"> <h2 title="Examples"><span></span> Examples</h2> <div id="list003" class="list"> <ul id="ul003"> <li class="defaultLink"><a href="all-examples.html">Examples</a></li> <li class="defaultLink"><a href="tutorials.html">Tutorials</a></li> <li class="defaultLink"><a href="demos.html">Demos</a></li> <li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </div> </div> </div> <div class="wrap"> <div class="toolbar"> <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>QFutureIterator</li> </ul> </div> <div class="toolbuttons toolblock"> <ul> <li id="smallA" class="t_button">A</li> <li id="medA" class="t_button active">A</li> <li id="bigA" class="t_button">A</li> <li id="print" class="t_button"><a href="javascript:this.print();"> <span>Print</span></a></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-functions">Public Functions</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <h1 class="title">QFutureIterator Class Reference</h1> <!-- $$$QFutureIterator-brief --> <p>The QFutureIterator class provides a Java-style const iterator for <a href="qfuture.html">QFuture</a>. <a href="#details">More...</a></p> <!-- @@@QFutureIterator --> <pre class="cpp"> <span class="preprocessor">#include <QFutureIterator></span></pre><p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p> <p>This class was introduced in Qt 4.4.</p> <ul> <li><a href="qfutureiterator-members.html">List of all members, including inherited members</a></li> </ul> <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="qfutureiterator.html#QFutureIterator">QFutureIterator</a></b> ( const QFuture<T> & <i>future</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qfutureiterator.html#findNext">findNext</a></b> ( const T & <i>value</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qfutureiterator.html#findPrevious">findPrevious</a></b> ( const T & <i>value</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qfutureiterator.html#hasNext">hasNext</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qfutureiterator.html#hasPrevious">hasPrevious</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> const T & </td><td class="memItemRight bottomAlign"><b><a href="qfutureiterator.html#next">next</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> const T & </td><td class="memItemRight bottomAlign"><b><a href="qfutureiterator.html#peekNext">peekNext</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> const T & </td><td class="memItemRight bottomAlign"><b><a href="qfutureiterator.html#peekPrevious">peekPrevious</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> const T & </td><td class="memItemRight bottomAlign"><b><a href="qfutureiterator.html#previous">previous</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfutureiterator.html#toBack">toBack</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfutureiterator.html#toFront">toFront</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QFutureIterator & </td><td class="memItemRight bottomAlign"><b><a href="qfutureiterator.html#operator-eq">operator=</a></b> ( const QFuture<T> & <i>future</i> )</td></tr> </table> <a name="details"></a> <!-- $$$QFutureIterator-description --> <div class="descr"> <h2>Detailed Description</h2> <p>The QFutureIterator class provides a Java-style const iterator for <a href="qfuture.html">QFuture</a>.</p> <p><a href="qfuture.html">QFuture</a> has both <a href="containers.html#java-style-iterators">Java-style iterators</a> and <a href="containers.html#stl-style-iterators">STL-style iterators</a>. The Java-style iterators are more high-level and easier to use than the STL-style iterators; on the other hand, they are slightly less efficient.</p> <p>An alternative to using iterators is to use index positions. Some <a href="qfuture.html">QFuture</a> member functions take an index as their first parameter, making it possible to access results without using iterators.</p> <p>QFutureIterator<T> allows you to iterate over a <a href="qfuture.html">QFuture</a><T>. Note that there is no mutable iterator for <a href="qfuture.html">QFuture</a> (unlike the other Java-style iterators).</p> <p>The QFutureIterator constructor takes a <a href="qfuture.html">QFuture</a> as its argument. After construction, the iterator is located at the very beginning of the result list (i.e. before the first result). Here's how to iterate over all the results sequentially:</p> <pre class="cpp"> <span class="type"><a href="qfuture.html">QFuture</a></span><span class="operator"><</span><span class="type"><a href="qstring.html">QString</a></span><span class="operator">></span> future; <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span> <span class="type">QFutureIterator</span><span class="operator"><</span><span class="type"><a href="qstring.html">QString</a></span><span class="operator">></span> i(future); <span class="keyword">while</span> (i<span class="operator">.</span>hasNext()) <a href="qtglobal.html#qDebug">qDebug</a>() <span class="operator"><</span><span class="operator"><</span> i<span class="operator">.</span><a href="qfutureiterator.html#next">next</a>();</pre> <p>The <a href="qfutureiterator.html#next">next</a>() function returns the next result (waiting for it to become available, if necessary) from the future and advances the iterator. Unlike STL-style iterators, Java-style iterators point <i>between</i> results rather than directly <i>at</i> results. The first call to <a href="qfutureiterator.html#next">next</a>() advances the iterator to the position between the first and second result, and returns the first result; the second call to <a href="qfutureiterator.html#next">next</a>() advances the iterator to the position between the second and third result, and returns the second result; and so on.</p> <p class="centerAlign"><img src="images/javaiterators1.png" alt="" /></p><p>Here's how to iterate over the elements in reverse order:</p> <pre class="cpp"> <span class="type">QFutureIterator</span><span class="operator"><</span><span class="type"><a href="qstring.html">QString</a></span><span class="operator">></span> i(future); i<span class="operator">.</span><a href="qfutureiterator.html#toBack">toBack</a>(); <span class="keyword">while</span> (i<span class="operator">.</span>hasPrevious()) <a href="qtglobal.html#qDebug">qDebug</a>() <span class="operator"><</span><span class="operator"><</span> i<span class="operator">.</span><a href="qfutureiterator.html#previous">previous</a>();</pre> <p>If you want to find all occurrences of a particular value, use <a href="qfutureiterator.html#findNext">findNext</a>() or <a href="qfutureiterator.html#findPrevious">findPrevious</a>() in a loop.</p> <p>Multiple iterators can be used on the same future. If the future is modified while a QFutureIterator is active, the QFutureIterator will continue iterating over the original future, ignoring the modified copy.</p> </div> <p><b>See also </b><a href="qfuture-const-iterator.html">QFuture::const_iterator</a> and <a href="qfuture.html">QFuture</a>.</p> <!-- @@@QFutureIterator --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QFutureIterator[overload1]$$$QFutureIteratorconstQFuture<T>& --> <h3 class="fn"><a name="QFutureIterator"></a>QFutureIterator::<span class="name">QFutureIterator</span> ( const <span class="type"><a href="qfuture.html">QFuture</a></span><<span class="type">T</span>> & <i>future</i> )</h3> <p>Constructs an iterator for traversing <i>future</i>. The iterator is set to be at the front of the result list (before the first result).</p> <p><b>See also </b><a href="qfutureiterator.html#operator-eq">operator=</a>().</p> <!-- @@@QFutureIterator --> <!-- $$$findNext[overload1]$$$findNextconstT& --> <h3 class="fn"><a name="findNext"></a><span class="type">bool</span> QFutureIterator::<span class="name">findNext</span> ( const <span class="type">T</span> & <i>value</i> )</h3> <p>Searches for <i>value</i> starting from the current iterator position forward. Returns true if <i>value</i> is found; otherwise returns false.</p> <p>After the call, if <i>value</i> was found, the iterator is positioned just after the matching result; otherwise, the iterator is positioned at the back of the result list.</p> <p><b>See also </b><a href="qfutureiterator.html#findPrevious">findPrevious</a>().</p> <!-- @@@findNext --> <!-- $$$findPrevious[overload1]$$$findPreviousconstT& --> <h3 class="fn"><a name="findPrevious"></a><span class="type">bool</span> QFutureIterator::<span class="name">findPrevious</span> ( const <span class="type">T</span> & <i>value</i> )</h3> <p>Searches for <i>value</i> starting from the current iterator position backward. Returns true if <i>value</i> is found; otherwise returns false.</p> <p>After the call, if <i>value</i> was found, the iterator is positioned just before the matching result; otherwise, the iterator is positioned at the front of the result list.</p> <p><b>See also </b><a href="qfutureiterator.html#findNext">findNext</a>().</p> <!-- @@@findPrevious --> <!-- $$$hasNext[overload1]$$$hasNext --> <h3 class="fn"><a name="hasNext"></a><span class="type">bool</span> QFutureIterator::<span class="name">hasNext</span> () const</h3> <p>Returns true if there is at least one result ahead of the iterator, e.g., the iterator is <i>not</i> at the back of the result list; otherwise returns false.</p> <p><b>See also </b><a href="qfutureiterator.html#hasPrevious">hasPrevious</a>() and <a href="qfutureiterator.html#next">next</a>().</p> <!-- @@@hasNext --> <!-- $$$hasPrevious[overload1]$$$hasPrevious --> <h3 class="fn"><a name="hasPrevious"></a><span class="type">bool</span> QFutureIterator::<span class="name">hasPrevious</span> () const</h3> <p>Returns true if there is at least one result ahead of the iterator, e.g., the iterator is <i>not</i> at the front of the result list; otherwise returns false.</p> <p><b>See also </b><a href="qfutureiterator.html#hasNext">hasNext</a>() and <a href="qfutureiterator.html#previous">previous</a>().</p> <!-- @@@hasPrevious --> <!-- $$$next[overload1]$$$next --> <h3 class="fn"><a name="next"></a>const <span class="type">T</span> & QFutureIterator::<span class="name">next</span> ()</h3> <p>Returns the next result and advances the iterator by one position.</p> <p>Calling this function on an iterator located at the back of the result list leads to undefined results.</p> <p><b>See also </b><a href="qfutureiterator.html#hasNext">hasNext</a>(), <a href="qfutureiterator.html#peekNext">peekNext</a>(), and <a href="qfutureiterator.html#previous">previous</a>().</p> <!-- @@@next --> <!-- $$$peekNext[overload1]$$$peekNext --> <h3 class="fn"><a name="peekNext"></a>const <span class="type">T</span> & QFutureIterator::<span class="name">peekNext</span> () const</h3> <p>Returns the next result without moving the iterator.</p> <p>Calling this function on an iterator located at the back of the result list leads to undefined results.</p> <p><b>See also </b><a href="qfutureiterator.html#hasNext">hasNext</a>(), <a href="qfutureiterator.html#next">next</a>(), and <a href="qfutureiterator.html#peekPrevious">peekPrevious</a>().</p> <!-- @@@peekNext --> <!-- $$$peekPrevious[overload1]$$$peekPrevious --> <h3 class="fn"><a name="peekPrevious"></a>const <span class="type">T</span> & QFutureIterator::<span class="name">peekPrevious</span> () const</h3> <p>Returns the previous result without moving the iterator.</p> <p>Calling this function on an iterator located at the front of the result list leads to undefined results.</p> <p><b>See also </b><a href="qfutureiterator.html#hasPrevious">hasPrevious</a>(), <a href="qfutureiterator.html#previous">previous</a>(), and <a href="qfutureiterator.html#peekNext">peekNext</a>().</p> <!-- @@@peekPrevious --> <!-- $$$previous[overload1]$$$previous --> <h3 class="fn"><a name="previous"></a>const <span class="type">T</span> & QFutureIterator::<span class="name">previous</span> ()</h3> <p>Returns the previous result and moves the iterator back by one position.</p> <p>Calling this function on an iterator located at the front of the result list leads to undefined results.</p> <p><b>See also </b><a href="qfutureiterator.html#hasPrevious">hasPrevious</a>(), <a href="qfutureiterator.html#peekPrevious">peekPrevious</a>(), and <a href="qfutureiterator.html#next">next</a>().</p> <!-- @@@previous --> <!-- $$$toBack[overload1]$$$toBack --> <h3 class="fn"><a name="toBack"></a><span class="type">void</span> QFutureIterator::<span class="name">toBack</span> ()</h3> <p>Moves the iterator to the back of the result list (after the last result).</p> <p><b>See also </b><a href="qfutureiterator.html#toFront">toFront</a>() and <a href="qfutureiterator.html#previous">previous</a>().</p> <!-- @@@toBack --> <!-- $$$toFront[overload1]$$$toFront --> <h3 class="fn"><a name="toFront"></a><span class="type">void</span> QFutureIterator::<span class="name">toFront</span> ()</h3> <p>Moves the iterator to the front of the result list (before the first result).</p> <p><b>See also </b><a href="qfutureiterator.html#toBack">toBack</a>() and <a href="qfutureiterator.html#next">next</a>().</p> <!-- @@@toFront --> <!-- $$$operator=[overload1]$$$operator=constQFuture<T>& --> <h3 class="fn"><a name="operator-eq"></a><span class="type">QFutureIterator</span> & QFutureIterator::<span class="name">operator=</span> ( const <span class="type"><a href="qfuture.html">QFuture</a></span><<span class="type">T</span>> & <i>future</i> )</h3> <p>Makes the iterator operate on <i>future</i>. The iterator is set to be at the front of the result list (before the first result).</p> <p><b>See also </b><a href="qfutureiterator.html#toFront">toFront</a>() and <a href="qfutureiterator.html#toBack">toBack</a>().</p> <!-- @@@operator= --> </div> </div> </div> </div> <div class="ft"> <span></span> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd. 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> 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. <a title="Privacy Policy" href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p> </div> <script src="scripts/functions.js" type="text/javascript"></script> </body> </html>