QRegularExpressionMatchIterator Class

// extracts the words
QRegularExpression re("(\\w+)");
QString subject("the quick fox");
QRegularExpressionMatchIterator i = re.globalMatch(subject);
while (i.hasNext()) {
    QRegularExpressionMatch match = i.next();
    // ...
}

// using a raw string literal, R"(raw_characters)", to be able to use "\w"
// without having to escape the backslash as "\\w"
QRegularExpression re(R"(\w+)");
QString subject("the quick fox");
for (const QRegularExpressionMatch &match : re.globalMatch(subject)) {
    // ...
}

Member Function Documentation

QRegularExpressionMatchIterator::QRegularExpressionMatchIterator()

Constructs an empty, valid QRegularExpressionMatchIterator object. The regular expression is set to a default-constructed one; the match type to QRegularExpression::NoMatch and the match options to QRegularExpression::NoMatchOption.

Invoking the hasNext() member function on the constructed object will return false, as the iterator is not iterating on a valid sequence of matches.

QRegularExpressionMatchIterator::QRegularExpressionMatchIterator(const QRegularExpressionMatchIterator &iterator)

Constructs a QRegularExpressionMatchIterator object as a copy of iterator.

See also operator=().

[since 6.1] QRegularExpressionMatchIterator::QRegularExpressionMatchIterator(QRegularExpressionMatchIterator &&iterator)

Constructs a QRegularExpressionMatchIterator object by moving from iterator.

Note that a moved-from QRegularExpressionMatchIterator can only be destroyed or assigned to. The effect of calling other functions than the destructor or one of the assignment operators is undefined.

This function was introduced in Qt 6.1.

See also operator=().

QRegularExpressionMatchIterator::~QRegularExpressionMatchIterator()

Destroys the QRegularExpressionMatchIterator object.

bool QRegularExpressionMatchIterator::hasNext() const

Returns true if there is at least one match result ahead of the iterator; otherwise it returns false.

See also next().

bool QRegularExpressionMatchIterator::isValid() const

Returns true if the iterator object was obtained as a result from the QRegularExpression::globalMatch() function invoked on a valid QRegularExpression object; returns false if the QRegularExpression was invalid.

See also QRegularExpression::globalMatch() and QRegularExpression::isValid().

QRegularExpression::MatchOptions QRegularExpressionMatchIterator::matchOptions() const

Returns the match options that were used to get this QRegularExpressionMatchIterator object, that is, the match options that were passed to QRegularExpression::globalMatch().

See also QRegularExpression::globalMatch(), regularExpression(), and matchType().

QRegularExpression::MatchType QRegularExpressionMatchIterator::matchType() const

Returns the match type that was used to get this QRegularExpressionMatchIterator object, that is, the match type that was passed to QRegularExpression::globalMatch().

See also QRegularExpression::globalMatch(), regularExpression(), and matchOptions().

QRegularExpressionMatch QRegularExpressionMatchIterator::next()

Returns the next match result and advances the iterator by one position.

QRegularExpressionMatch QRegularExpressionMatchIterator::peekNext() const

Returns the next match result without moving the iterator.

QRegularExpression QRegularExpressionMatchIterator::regularExpression() const

Returns the QRegularExpression object whose globalMatch() function returned this object.

See also QRegularExpression::globalMatch(), matchType(), and matchOptions().

void QRegularExpressionMatchIterator::swap(QRegularExpressionMatchIterator &other)

Swaps the iterator other with this iterator object. This operation is very fast and never fails.

QRegularExpressionMatchIterator &QRegularExpressionMatchIterator::operator=(const QRegularExpressionMatchIterator &iterator)

Assigns the iterator iterator to this object, and returns a reference to the copy.

QRegularExpressionMatchIterator &QRegularExpressionMatchIterator::operator=(QRegularExpressionMatchIterator &&iterator)

Move-assigns the iterator to this object, and returns a reference to the result.

Note that a moved-from QRegularExpressionMatchIterator can only be destroyed or assigned to. The effect of calling other functions than the destructor or one of the assignment operators is undefined.