<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qiterator.qdoc -->
<title>QSetIterator Class | Qt Core 5.11</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 ><a href="../qtdoc/index.html">Qt 5.11</a></td><td ><a href="qtcore-index.html">Qt Core</a></td><td ><a href="qtcore-module.html">C++ Classes</a></td><td >QSetIterator</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.11.2 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-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">QSetIterator Class</h1>
<!-- $$$QSetIterator-brief -->
<p>The <a href="qsetiterator.html">QSetIterator</a> class provides a Java-style const iterator for <a href="qset.html">QSet</a>. <a href="#details">More...</a></p>
<!-- @@@QSetIterator -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QSetIterator></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += core</td></tr></table></div><ul>
<li><a href="qsetiterator-members.html">List of all members, including inherited members</a></li>
</ul>
<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="qsetiterator.html#QSetIterator">QSetIterator</a></b>(const QSet<T> &<i>set</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsetiterator.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="qsetiterator.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="qsetiterator.html#hasNext">hasNext</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsetiterator.html#hasPrevious">hasPrevious</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const T &</td><td class="memItemRight bottomAlign"><b><a href="qsetiterator.html#next">next</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const T &</td><td class="memItemRight bottomAlign"><b><a href="qsetiterator.html#peekNext">peekNext</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const T &</td><td class="memItemRight bottomAlign"><b><a href="qsetiterator.html#peekPrevious">peekPrevious</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const T &</td><td class="memItemRight bottomAlign"><b><a href="qsetiterator.html#previous">previous</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsetiterator.html#toBack">toBack</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsetiterator.html#toFront">toFront</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSetIterator<T> &</td><td class="memItemRight bottomAlign"><b><a href="qsetiterator.html#operator-eq">operator=</a></b>(const QSet<T> &<i>container</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QSetIterator-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qsetiterator.html">QSetIterator</a> class provides a Java-style const iterator for <a href="qset.html">QSet</a>.</p>
<p><a href="qset.html">QSet</a> supports 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><a href="qsetiterator.html">QSetIterator</a><T> allows you to iterate over a <a href="qset.html">QSet</a><T>. If you want to modify the set as you iterate over it, use <a href="qmutablesetiterator.html">QMutableSetIterator</a><T> instead.</p>
<p>The constructor takes a <a href="qset.html">QSet</a> as argument. After construction, the iterator is located at the very beginning of the set (before the first item). Here's how to iterate over all the elements sequentially:</p>
<pre class="cpp">
<span class="type"><a href="qset.html">QSet</a></span><span class="operator"><</span><span class="type"><a href="qstring.html">QString</a></span><span class="operator">></span> set;
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
<span class="type"><a href="qsetiterator.html#QSetIterator">QSetIterator</a></span><span class="operator"><</span><span class="type"><a href="qstring.html">QString</a></span><span class="operator">></span> i(set);
<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>next();
</pre>
<p>The <a href="qsetiterator.html#next">next</a>() function returns the next item in the set and advances the iterator. Unlike STL-style iterators, Java-style iterators point <i>between</i> items rather than directly <i>at</i> items. The first call to <a href="qsetiterator.html#next">next</a>() advances the iterator to the position between the first and second item, and returns the first item; the second call to <a href="qsetiterator.html#next">next</a>() advances the iterator to the position between the second and third item, returning the second item; 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"><a href="qsetiterator.html#QSetIterator">QSetIterator</a></span><span class="operator"><</span><span class="type"><a href="qstring.html">QString</a></span><span class="operator">></span> i(set);
i<span class="operator">.</span>toBack();
<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>previous();
</pre>
<p>If you want to find all occurrences of a particular value, use <a href="qsetiterator.html#findNext">findNext</a>() or <a href="qsetiterator.html#findPrevious">findPrevious</a>() in a loop.</p>
<p>Multiple iterators can be used on the same set. If the set is modified while a <a href="qsetiterator.html">QSetIterator</a> is active, the <a href="qsetiterator.html">QSetIterator</a> will continue iterating over the original set, ignoring the modified copy.</p>
</div>
<p><b>See also </b><a href="qmutablesetiterator.html">QMutableSetIterator</a> and <a href="qset-const-iterator.html">QSet::const_iterator</a>.</p>
<!-- @@@QSetIterator -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$ -->
<h3 class="fn fngroupitem" id="findPrevious"><a name="findPrevious"></a><span class="type">bool</span> QSetIterator::<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 <code>true</code> 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 item; otherwise, the iterator is positioned at the front of the container.</p>
<p><b>See also </b><a href="qsetiterator.html#findNext">findNext</a>().</p>
<!-- @@@ -->
<!-- $$$ -->
<h3 class="fn fngroupitem" id="findNext"><a name="findNext"></a><span class="type">bool</span> QSetIterator::<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 <code>true</code> if <i>value</i> is found; otherwise returns <code>false</code>.</p>
<p>After the call, if <i>value</i> was found, the iterator is positioned just after the matching item; otherwise, the iterator is positioned at the back of the container.</p>
<p><b>See also </b><a href="qsetiterator.html#findPrevious">findPrevious</a>().</p>
<!-- @@@ -->
<!-- $$$ -->
<h3 class="fn fngroupitem" id="peekPrevious"><a name="peekPrevious"></a>const <span class="type">T</span> &QSetIterator::<span class="name">peekPrevious</span>() const</h3>
<p>Returns the previous item without moving the iterator.</p>
<p>Calling this function on an iterator located at the front of the container leads to undefined results.</p>
<p><b>See also </b><a href="qsetiterator.html#hasPrevious">hasPrevious</a>(), <a href="qsetiterator.html#previous">previous</a>(), and <a href="qsetiterator.html#peekNext">peekNext</a>().</p>
<!-- @@@ -->
<!-- $$$ -->
<h3 class="fn fngroupitem" id="previous"><a name="previous"></a>const <span class="type">T</span> &QSetIterator::<span class="name">previous</span>()</h3>
<p>Returns the previous item and moves the iterator back by one position.</p>
<p>Calling this function on an iterator located at the front of the container leads to undefined results.</p>
<p><b>See also </b><a href="qsetiterator.html#hasPrevious">hasPrevious</a>(), <a href="qsetiterator.html#peekPrevious">peekPrevious</a>(), and <a href="qsetiterator.html#next">next</a>().</p>
<!-- @@@ -->
<!-- $$$ -->
<h3 class="fn fngroupitem" id="hasPrevious"><a name="hasPrevious"></a><span class="type">bool</span> QSetIterator::<span class="name">hasPrevious</span>() const</h3>
<p>Returns <code>true</code> if there is at least one item behind the iterator, i.e. the iterator is <i>not</i> at the front of the container; otherwise returns <code>false</code>.</p>
<p><b>See also </b><a href="qsetiterator.html#hasNext">hasNext</a>() and <a href="qsetiterator.html#previous">previous</a>().</p>
<!-- @@@ -->
<!-- $$$ -->
<h3 class="fn fngroupitem" id="peekNext"><a name="peekNext"></a>const <span class="type">T</span> &QSetIterator::<span class="name">peekNext</span>() const</h3>
<p>Returns the next item without moving the iterator.</p>
<p>Calling this function on an iterator located at the back of the container leads to undefined results.</p>
<p><b>See also </b><a href="qsetiterator.html#hasNext">hasNext</a>(), <a href="qsetiterator.html#next">next</a>(), and <a href="qsetiterator.html#peekPrevious">peekPrevious</a>().</p>
<!-- @@@ -->
<!-- $$$ -->
<h3 class="fn fngroupitem" id="next"><a name="next"></a>const <span class="type">T</span> &QSetIterator::<span class="name">next</span>()</h3>
<p>Returns the next item and advances the iterator by one position.</p>
<p>Calling this function on an iterator located at the back of the container leads to undefined results.</p>
<p><b>See also </b><a href="qsetiterator.html#hasNext">hasNext</a>(), <a href="qsetiterator.html#peekNext">peekNext</a>(), and <a href="qsetiterator.html#previous">previous</a>().</p>
<!-- @@@ -->
<!-- $$$ -->
<h3 class="fn fngroupitem" id="hasNext"><a name="hasNext"></a><span class="type">bool</span> QSetIterator::<span class="name">hasNext</span>() const</h3>
<p>Returns <code>true</code> if there is at least one item ahead of the iterator, i.e. the iterator is <i>not</i> at the back of the container; otherwise returns <code>false</code>.</p>
<p><b>See also </b><a href="qsetiterator.html#hasPrevious">hasPrevious</a>() and <a href="qsetiterator.html#next">next</a>().</p>
<!-- @@@ -->
<!-- $$$ -->
<h3 class="fn fngroupitem" id="toBack"><a name="toBack"></a><span class="type">void</span> QSetIterator::<span class="name">toBack</span>()</h3>
<p>Moves the iterator to the back of the container (after the last item).</p>
<p><b>See also </b><a href="qsetiterator.html#toFront">toFront</a>() and <a href="qsetiterator.html#previous">previous</a>().</p>
<!-- @@@ -->
<!-- $$$ -->
<h3 class="fn fngroupitem" id="toFront"><a name="toFront"></a><span class="type">void</span> QSetIterator::<span class="name">toFront</span>()</h3>
<p>Moves the iterator to the front of the container (before the first item).</p>
<p><b>See also </b><a href="qsetiterator.html#toBack">toBack</a>() and <a href="qsetiterator.html#next">next</a>().</p>
<!-- @@@ -->
<!-- $$$ -->
<h3 class="fn fngroupitem" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qsetiterator.html#QSetIterator">QSetIterator</a></span><<span class="type">T</span>> &QSetIterator::<span class="name">operator=</span>(const <span class="type"><a href="qset.html">QSet</a></span><<span class="type">T</span>> &<i>container</i>)</h3>
<p>Makes the iterator operate on <i>set</i>. The iterator is set to be at the front of the set (before the first item).</p>
<p><b>See also </b><a href="qsetiterator.html#toFront">toFront</a>() and <a href="qsetiterator.html#toBack">toBack</a>().</p>
<!-- @@@ -->
<!-- $$$ -->
<h3 class="fn fngroupitem" id="QSetIterator"><a name="QSetIterator"></a>QSetIterator::<span class="name">QSetIterator</span>(const <span class="type"><a href="qset.html">QSet</a></span><<span class="type">T</span>> &<i>set</i>)</h3>
<p>Constructs an iterator for traversing <i>set</i>. The iterator is set to be at the front of the set (before the first item).</p>
<p><b>See also </b><a href="qsetiterator.html#operator-eq">operator=</a>().</p>
<!-- @@@ -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2018 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>