API reference - Class QRegularExpression

!=

Signature: [const] bool != (const QRegularExpression re)

Description: Method bool QRegularExpression::operator!=(const QRegularExpression &re)

==

Signature: [const] bool == (const QRegularExpression re)

Description: Method bool QRegularExpression::operator==(const QRegularExpression &re)

AnchoredMatchOption

Signature: [static,const] QRegularExpression_MatchOption AnchoredMatchOption

Description: Enum constant QRegularExpression::AnchoredMatchOption

Python specific notes:
The object exposes a readable attribute 'AnchoredMatchOption'. This is the getter.

CaseInsensitiveOption

Signature: [static,const] QRegularExpression_PatternOption CaseInsensitiveOption

Description: Enum constant QRegularExpression::CaseInsensitiveOption

Python specific notes:
The object exposes a readable attribute 'CaseInsensitiveOption'. This is the getter.

DontAutomaticallyOptimizeOption

Signature: [static,const] QRegularExpression_PatternOption DontAutomaticallyOptimizeOption

Description: Enum constant QRegularExpression::DontAutomaticallyOptimizeOption

Python specific notes:
The object exposes a readable attribute 'DontAutomaticallyOptimizeOption'. This is the getter.

DontCaptureOption

Signature: [static,const] QRegularExpression_PatternOption DontCaptureOption

Description: Enum constant QRegularExpression::DontCaptureOption

Python specific notes:
The object exposes a readable attribute 'DontCaptureOption'. This is the getter.

DontCheckSubjectStringMatchOption

Signature: [static,const] QRegularExpression_MatchOption DontCheckSubjectStringMatchOption

Description: Enum constant QRegularExpression::DontCheckSubjectStringMatchOption

Python specific notes:
The object exposes a readable attribute 'DontCheckSubjectStringMatchOption'. This is the getter.

DotMatchesEverythingOption

Signature: [static,const] QRegularExpression_PatternOption DotMatchesEverythingOption

Description: Enum constant QRegularExpression::DotMatchesEverythingOption

Python specific notes:
The object exposes a readable attribute 'DotMatchesEverythingOption'. This is the getter.

ExtendedPatternSyntaxOption

Signature: [static,const] QRegularExpression_PatternOption ExtendedPatternSyntaxOption

Description: Enum constant QRegularExpression::ExtendedPatternSyntaxOption

Python specific notes:
The object exposes a readable attribute 'ExtendedPatternSyntaxOption'. This is the getter.

InvertedGreedinessOption

Signature: [static,const] QRegularExpression_PatternOption InvertedGreedinessOption

Description: Enum constant QRegularExpression::InvertedGreedinessOption

Python specific notes:
The object exposes a readable attribute 'InvertedGreedinessOption'. This is the getter.

MultilineOption

Signature: [static,const] QRegularExpression_PatternOption MultilineOption

Description: Enum constant QRegularExpression::MultilineOption

Python specific notes:
The object exposes a readable attribute 'MultilineOption'. This is the getter.

NoMatch

Signature: [static,const] QRegularExpression_MatchType NoMatch

Description: Enum constant QRegularExpression::NoMatch

Python specific notes:
The object exposes a readable attribute 'NoMatch'. This is the getter.

NoMatchOption

Signature: [static,const] QRegularExpression_MatchOption NoMatchOption

Description: Enum constant QRegularExpression::NoMatchOption

Python specific notes:
The object exposes a readable attribute 'NoMatchOption'. This is the getter.

NoPatternOption

Signature: [static,const] QRegularExpression_PatternOption NoPatternOption

Description: Enum constant QRegularExpression::NoPatternOption

Python specific notes:
The object exposes a readable attribute 'NoPatternOption'. This is the getter.

NormalMatch

Signature: [static,const] QRegularExpression_MatchType NormalMatch

Description: Enum constant QRegularExpression::NormalMatch

Python specific notes:
The object exposes a readable attribute 'NormalMatch'. This is the getter.

OptimizeOnFirstUsageOption

Signature: [static,const] QRegularExpression_PatternOption OptimizeOnFirstUsageOption

Description: Enum constant QRegularExpression::OptimizeOnFirstUsageOption

Python specific notes:
The object exposes a readable attribute 'OptimizeOnFirstUsageOption'. This is the getter.

PartialPreferCompleteMatch

Signature: [static,const] QRegularExpression_MatchType PartialPreferCompleteMatch

Description: Enum constant QRegularExpression::PartialPreferCompleteMatch

Python specific notes:
The object exposes a readable attribute 'PartialPreferCompleteMatch'. This is the getter.

PartialPreferFirstMatch

Signature: [static,const] QRegularExpression_MatchType PartialPreferFirstMatch

Description: Enum constant QRegularExpression::PartialPreferFirstMatch

Python specific notes:
The object exposes a readable attribute 'PartialPreferFirstMatch'. This is the getter.

UseUnicodePropertiesOption

Signature: [static,const] QRegularExpression_PatternOption UseUnicodePropertiesOption

Description: Enum constant QRegularExpression::UseUnicodePropertiesOption

Python specific notes:
The object exposes a readable attribute 'UseUnicodePropertiesOption'. This is the getter.

_assign

Signature: void _assign (const QRegularExpression other)

Description: Assigns another object to self

_const_cast

Signature: [const] QRegularExpression ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

anchoredPattern

Signature: [static] string anchoredPattern (string expression)

Description: Static method QString QRegularExpression::anchoredPattern(const QString &expression)

This method is static and can be called without an instance.

assign

Signature: QRegularExpression assign (const QRegularExpression re)

Description: Method QRegularExpression &QRegularExpression::operator=(const QRegularExpression &re)

captureCount

Signature: [const] int captureCount

Description: Method int QRegularExpression::captureCount()

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

dup

Signature: [const] new QRegularExpression ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

errorString

Signature: [const] string errorString

Description: Method QString QRegularExpression::errorString()

escape

Signature: [static] string escape (string str)

Description: Static method QString QRegularExpression::escape(const QString &str)

This method is static and can be called without an instance.

globalMatch

Signature: [const] QRegularExpressionMatchIterator globalMatch (string subject, int offset = 0, const QRegularExpression_MatchType matchType = QRegularExpression::NormalMatch, QRegularExpression_QFlags_MatchOption matchOptions = QRegularExpression::NoMatchOption)

Description: Method QRegularExpressionMatchIterator QRegularExpression::globalMatch(const QString &subject, int offset, QRegularExpression::MatchType matchType, QFlags<QRegularExpression::MatchOption> matchOptions)

isValid?

Signature: [const] bool isValid?

Description: Method bool QRegularExpression::isValid()

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

match

Signature: [const] QRegularExpressionMatch match (string subject, int offset = 0, const QRegularExpression_MatchType matchType = QRegularExpression::NormalMatch, QRegularExpression_QFlags_MatchOption matchOptions = QRegularExpression::NoMatchOption)

Description: Method QRegularExpressionMatch QRegularExpression::match(const QString &subject, int offset, QRegularExpression::MatchType matchType, QFlags<QRegularExpression::MatchOption> matchOptions)

namedCaptureGroups

Signature: [const] string[] namedCaptureGroups

Description: Method QStringList QRegularExpression::namedCaptureGroups()

new

(1) Signature: [static] new QRegularExpression new

Description: Constructor QRegularExpression::QRegularExpression()

This method creates an object of class QRegularExpression.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QRegularExpression new (string pattern, QRegularExpression_QFlags_PatternOption options = QRegularExpression::NoPatternOption)

Description: Constructor QRegularExpression::QRegularExpression(const QString &pattern, QFlags<QRegularExpression::PatternOption> options)

This method creates an object of class QRegularExpression.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QRegularExpression new (const QRegularExpression re)

Description: Constructor QRegularExpression::QRegularExpression(const QRegularExpression &re)

This method creates an object of class QRegularExpression.

Python specific notes:
This method is the default initializer of the object.

optimize

Signature: [const] void optimize

Description: Method void QRegularExpression::optimize()

pattern

Signature: [const] string pattern

Description: Method QString QRegularExpression::pattern()

Python specific notes:
The object exposes a readable attribute 'pattern'. This is the getter.

pattern=

Signature: void pattern= (string pattern)

Description: Method void QRegularExpression::setPattern(const QString &pattern)

Python specific notes:
The object exposes a writable attribute 'pattern'. This is the setter.

patternErrorOffset

Signature: [const] int patternErrorOffset

Description: Method int QRegularExpression::patternErrorOffset()

patternOptions

Signature: [const] QRegularExpression_QFlags_PatternOption patternOptions

Description: Method QFlags<QRegularExpression::PatternOption> QRegularExpression::patternOptions()

Python specific notes:
The object exposes a readable attribute 'patternOptions'. This is the getter.

patternOptions=

Signature: void patternOptions= (QRegularExpression_QFlags_PatternOption options)

Description: Method void QRegularExpression::setPatternOptions(QFlags<QRegularExpression::PatternOption> options)

Python specific notes:
The object exposes a writable attribute 'patternOptions'. This is the setter.

setPattern

Signature: void setPattern (string pattern)

Description: Method void QRegularExpression::setPattern(const QString &pattern)

Python specific notes:
The object exposes a writable attribute 'pattern'. This is the setter.

setPatternOptions

Signature: void setPatternOptions (QRegularExpression_QFlags_PatternOption options)

Description: Method void QRegularExpression::setPatternOptions(QFlags<QRegularExpression::PatternOption> options)

Python specific notes:
The object exposes a writable attribute 'patternOptions'. This is the setter.

swap

Signature: void swap (QRegularExpression other)

Description: Method void QRegularExpression::swap(QRegularExpression &other)

wildcardToRegularExpression

Signature: [static] string wildcardToRegularExpression (string str)

Description: Static method QString QRegularExpression::wildcardToRegularExpression(const QString &str)

This method is static and can be called without an instance.