<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qregularexpression.cpp -->
<title>QRegularExpressionMatchIterator Class | Qt Core 5.12.6</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.12</td><td ><a href="qtcore-index.html">Qt Core</a></td><td ><a href="qtcore-module.html">C++ Classes</a></td><td >QRegularExpressionMatchIterator</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtcore-index.html">Qt 5.12.6 Reference Documentation</a></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">QRegularExpressionMatchIterator Class</h1>
<!-- $$$QRegularExpressionMatchIterator-brief -->
<p>The <a href="qregularexpressionmatchiterator.html">QRegularExpressionMatchIterator</a> class provides an iterator on the results of a global match of a <a href="qregularexpression.html">QRegularExpression</a> object against a string. <a href="#details">More...</a></p>
<!-- @@@QRegularExpressionMatchIterator -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QRegularExpressionMatchIterator></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 5.0</td></tr></table></div><ul>
<li><a href="qregularexpressionmatchiterator-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-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="qregularexpressionmatchiterator.html#QRegularExpressionMatchIterator">QRegularExpressionMatchIterator</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qregularexpressionmatchiterator.html#QRegularExpressionMatchIterator-1">QRegularExpressionMatchIterator</a></b>(const QRegularExpressionMatchIterator &<i>iterator</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qregularexpressionmatchiterator.html#dtor.QRegularExpressionMatchIterator">~QRegularExpressionMatchIterator</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qregularexpressionmatchiterator.html#hasNext">hasNext</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qregularexpressionmatchiterator.html#isValid">isValid</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRegularExpression::MatchOptions </td><td class="memItemRight bottomAlign"><b><a href="qregularexpressionmatchiterator.html#matchOptions">matchOptions</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRegularExpression::MatchType </td><td class="memItemRight bottomAlign"><b><a href="qregularexpressionmatchiterator.html#matchType">matchType</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRegularExpressionMatch </td><td class="memItemRight bottomAlign"><b><a href="qregularexpressionmatchiterator.html#next">next</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRegularExpressionMatch </td><td class="memItemRight bottomAlign"><b><a href="qregularexpressionmatchiterator.html#peekNext">peekNext</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRegularExpression </td><td class="memItemRight bottomAlign"><b><a href="qregularexpressionmatchiterator.html#regularExpression">regularExpression</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qregularexpressionmatchiterator.html#swap">swap</a></b>(QRegularExpressionMatchIterator &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRegularExpressionMatchIterator &</td><td class="memItemRight bottomAlign"><b><a href="qregularexpressionmatchiterator.html#operator-eq">operator=</a></b>(const QRegularExpressionMatchIterator &<i>iterator</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRegularExpressionMatchIterator &</td><td class="memItemRight bottomAlign"><b><a href="qregularexpressionmatchiterator.html#operator-eq-1">operator=</a></b>(QRegularExpressionMatchIterator &&<i>iterator</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QRegularExpressionMatchIterator-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qregularexpressionmatchiterator.html">QRegularExpressionMatchIterator</a> class provides an iterator on the results of a global match of a <a href="qregularexpression.html">QRegularExpression</a> object against a string.</p>
<p>A <a href="qregularexpressionmatchiterator.html">QRegularExpressionMatchIterator</a> object is a forward only Java-like iterator; it can be obtained by calling the <a href="qregularexpression.html#globalMatch">QRegularExpression::globalMatch</a>() function. A new <a href="qregularexpressionmatchiterator.html">QRegularExpressionMatchIterator</a> will be positioned before the first result. You can then call the <a href="qregularexpressionmatchiterator.html#hasNext">hasNext</a>() function to check if there are more results available; if so, the <a href="qregularexpressionmatchiterator.html#next">next</a>() function will return the next result and advance the iterator.</p>
<p>Each result is a <a href="qregularexpressionmatch.html">QRegularExpressionMatch</a> object holding all the information for that result (including captured substrings).</p>
<p>For instance:</p>
<pre class="cpp">
<span class="comment">// extracts the words</span>
<span class="type"><a href="qregularexpression.html">QRegularExpression</a></span> re(<span class="string">"(\\w+)"</span>);
<span class="type"><a href="qstring.html">QString</a></span> subject(<span class="string">"the quick fox"</span>);
<span class="type"><a href="qregularexpressionmatchiterator.html#QRegularExpressionMatchIterator">QRegularExpressionMatchIterator</a></span> i <span class="operator">=</span> re<span class="operator">.</span>globalMatch(subject);
<span class="keyword">while</span> (i<span class="operator">.</span>hasNext()) {
<span class="type"><a href="qregularexpressionmatch.html">QRegularExpressionMatch</a></span> match <span class="operator">=</span> i<span class="operator">.</span>next();
<span class="comment">// ...</span>
}
</pre>
<p>Moreover, <a href="qregularexpressionmatchiterator.html">QRegularExpressionMatchIterator</a> offers a <a href="qregularexpressionmatchiterator.html#peekNext">peekNext</a>() function to get the next result <i>without</i> advancing the iterator.</p>
<p>You can retrieve the <a href="qregularexpression.html">QRegularExpression</a> object the subject string was matched against by calling the <a href="qregularexpressionmatchiterator.html#regularExpression">regularExpression</a>() function; the match type and the match options are available as well by calling the <a href="qregularexpressionmatchiterator.html#matchType">matchType</a>() and the <a href="qregularexpressionmatchiterator.html#matchOptions">matchOptions</a>() respectively.</p>
<p>Please refer to the <a href="qregularexpression.html">QRegularExpression</a> documentation for more information about the Qt regular expression classes.</p>
</div>
<p><b>See also </b><a href="qregularexpression.html">QRegularExpression</a> and <a href="qregularexpressionmatch.html">QRegularExpressionMatch</a>.</p>
<!-- @@@QRegularExpressionMatchIterator -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QRegularExpressionMatchIterator[overload1]$$$QRegularExpressionMatchIterator -->
<h3 class="fn" id="QRegularExpressionMatchIterator"><a name="QRegularExpressionMatchIterator"></a>QRegularExpressionMatchIterator::<span class="name">QRegularExpressionMatchIterator</span>()</h3>
<p>Constructs an empty, valid <a href="qregularexpressionmatchiterator.html">QRegularExpressionMatchIterator</a> object. The regular expression is set to a default-constructed one; the match type to <a href="qregularexpression.html#MatchType-enum">QRegularExpression::NoMatch</a> and the match options to <a href="qregularexpression.html#MatchOption-enum">QRegularExpression::NoMatchOption</a>.</p>
<p>Invoking the <a href="qregularexpressionmatchiterator.html#hasNext">hasNext</a>() member function on the constructed object will return false, as the iterator is not iterating on a valid sequence of matches.</p>
<p>This function was introduced in Qt 5.1.</p>
<!-- @@@QRegularExpressionMatchIterator -->
<!-- $$$QRegularExpressionMatchIterator$$$QRegularExpressionMatchIteratorconstQRegularExpressionMatchIterator& -->
<h3 class="fn" id="QRegularExpressionMatchIterator-1"><a name="QRegularExpressionMatchIterator-1"></a>QRegularExpressionMatchIterator::<span class="name">QRegularExpressionMatchIterator</span>(const <span class="type"><a href="qregularexpressionmatchiterator.html#QRegularExpressionMatchIterator">QRegularExpressionMatchIterator</a></span> &<i>iterator</i>)</h3>
<p>Constructs a <a href="qregularexpressionmatchiterator.html">QRegularExpressionMatchIterator</a> object as a copy of <i>iterator</i>.</p>
<p><b>See also </b><a href="qregularexpressionmatchiterator.html#operator-eq">operator=</a>().</p>
<!-- @@@QRegularExpressionMatchIterator -->
<!-- $$$~QRegularExpressionMatchIterator[overload1]$$$~QRegularExpressionMatchIterator -->
<h3 class="fn" id="dtor.QRegularExpressionMatchIterator"><a name="dtor.QRegularExpressionMatchIterator"></a>QRegularExpressionMatchIterator::<span class="name">~QRegularExpressionMatchIterator</span>()</h3>
<p>Destroys the <a href="qregularexpressionmatchiterator.html">QRegularExpressionMatchIterator</a> object.</p>
<!-- @@@~QRegularExpressionMatchIterator -->
<!-- $$$hasNext[overload1]$$$hasNext -->
<h3 class="fn" id="hasNext"><a name="hasNext"></a><span class="type">bool</span> QRegularExpressionMatchIterator::<span class="name">hasNext</span>() const</h3>
<p>Returns <code>true</code> if there is at least one match result ahead of the iterator; otherwise it returns <code>false</code>.</p>
<p><b>See also </b><a href="qregularexpressionmatchiterator.html#next">next</a>().</p>
<!-- @@@hasNext -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn" id="isValid"><a name="isValid"></a><span class="type">bool</span> QRegularExpressionMatchIterator::<span class="name">isValid</span>() const</h3>
<p>Returns <code>true</code> if the iterator object was obtained as a result from the <a href="qregularexpression.html#globalMatch">QRegularExpression::globalMatch</a>() function invoked on a valid <a href="qregularexpression.html">QRegularExpression</a> object; returns <code>false</code> if the <a href="qregularexpression.html">QRegularExpression</a> was invalid.</p>
<p><b>See also </b><a href="qregularexpression.html#globalMatch">QRegularExpression::globalMatch</a>() and <a href="qregularexpression.html#isValid">QRegularExpression::isValid</a>().</p>
<!-- @@@isValid -->
<!-- $$$matchOptions[overload1]$$$matchOptions -->
<h3 class="fn" id="matchOptions"><a name="matchOptions"></a><span class="type"><a href="qregularexpression.html#MatchOption-enum">QRegularExpression::MatchOptions</a></span> QRegularExpressionMatchIterator::<span class="name">matchOptions</span>() const</h3>
<p>Returns the match options that were used to get this <a href="qregularexpressionmatchiterator.html">QRegularExpressionMatchIterator</a> object, that is, the match options that were passed to <a href="qregularexpression.html#globalMatch">QRegularExpression::globalMatch</a>().</p>
<p><b>See also </b><a href="qregularexpression.html#globalMatch">QRegularExpression::globalMatch</a>(), <a href="qregularexpressionmatchiterator.html#regularExpression">regularExpression</a>(), and <a href="qregularexpressionmatchiterator.html#matchType">matchType</a>().</p>
<!-- @@@matchOptions -->
<!-- $$$matchType[overload1]$$$matchType -->
<h3 class="fn" id="matchType"><a name="matchType"></a><span class="type"><a href="qregularexpression.html#MatchType-enum">QRegularExpression::MatchType</a></span> QRegularExpressionMatchIterator::<span class="name">matchType</span>() const</h3>
<p>Returns the match type that was used to get this <a href="qregularexpressionmatchiterator.html">QRegularExpressionMatchIterator</a> object, that is, the match type that was passed to <a href="qregularexpression.html#globalMatch">QRegularExpression::globalMatch</a>().</p>
<p><b>See also </b><a href="qregularexpression.html#globalMatch">QRegularExpression::globalMatch</a>(), <a href="qregularexpressionmatchiterator.html#regularExpression">regularExpression</a>(), and <a href="qregularexpressionmatchiterator.html#matchOptions">matchOptions</a>().</p>
<!-- @@@matchType -->
<!-- $$$next[overload1]$$$next -->
<h3 class="fn" id="next"><a name="next"></a><span class="type"><a href="qregularexpressionmatch.html">QRegularExpressionMatch</a></span> QRegularExpressionMatchIterator::<span class="name">next</span>()</h3>
<p>Returns the next match result and advances the iterator by one position.</p>
<p><b>Note: </b>Calling this function when the iterator is at the end of the result set leads to undefined results.</p><!-- @@@next -->
<!-- $$$peekNext[overload1]$$$peekNext -->
<h3 class="fn" id="peekNext"><a name="peekNext"></a><span class="type"><a href="qregularexpressionmatch.html">QRegularExpressionMatch</a></span> QRegularExpressionMatchIterator::<span class="name">peekNext</span>() const</h3>
<p>Returns the next match result without moving the iterator.</p>
<p><b>Note: </b>Calling this function when the iterator is at the end of the result set leads to undefined results.</p><!-- @@@peekNext -->
<!-- $$$regularExpression[overload1]$$$regularExpression -->
<h3 class="fn" id="regularExpression"><a name="regularExpression"></a><span class="type"><a href="qregularexpression.html">QRegularExpression</a></span> QRegularExpressionMatchIterator::<span class="name">regularExpression</span>() const</h3>
<p>Returns the <a href="qregularexpression.html">QRegularExpression</a> object whose globalMatch() function returned this object.</p>
<p><b>See also </b><a href="qregularexpression.html#globalMatch">QRegularExpression::globalMatch</a>(), <a href="qregularexpressionmatchiterator.html#matchType">matchType</a>(), and <a href="qregularexpressionmatchiterator.html#matchOptions">matchOptions</a>().</p>
<!-- @@@regularExpression -->
<!-- $$$swap[overload1]$$$swapQRegularExpressionMatchIterator& -->
<h3 class="fn" id="swap"><a name="swap"></a><span class="type">void</span> QRegularExpressionMatchIterator::<span class="name">swap</span>(<span class="type"><a href="qregularexpressionmatchiterator.html#QRegularExpressionMatchIterator">QRegularExpressionMatchIterator</a></span> &<i>other</i>)</h3>
<p>Swaps the iterator <i>other</i> with this iterator object. This operation is very fast and never fails.</p>
<!-- @@@swap -->
<!-- $$$operator=[overload1]$$$operator=constQRegularExpressionMatchIterator& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qregularexpressionmatchiterator.html#QRegularExpressionMatchIterator">QRegularExpressionMatchIterator</a></span> &QRegularExpressionMatchIterator::<span class="name">operator=</span>(const <span class="type"><a href="qregularexpressionmatchiterator.html#QRegularExpressionMatchIterator">QRegularExpressionMatchIterator</a></span> &<i>iterator</i>)</h3>
<p>Assigns the iterator <i>iterator</i> to this object, and returns a reference to the copy.</p>
<!-- @@@operator= -->
<!-- $$$operator=$$$operator=QRegularExpressionMatchIterator&& -->
<h3 class="fn" id="operator-eq-1"><a name="operator-eq-1"></a><span class="type"><a href="qregularexpressionmatchiterator.html#QRegularExpressionMatchIterator">QRegularExpressionMatchIterator</a></span> &QRegularExpressionMatchIterator::<span class="name">operator=</span>(<span class="type"><a href="qregularexpressionmatchiterator.html#QRegularExpressionMatchIterator">QRegularExpressionMatchIterator</a></span> &&<i>iterator</i>)</h3>
<p>Move-assigns the <i>iterator</i> to this object.</p>
<!-- @@@operator= -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 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>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
d5e62c01ae8d1e579463c6a871dd44bf
>
files
>
670
