API reference - Class QRegExp

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QRegExp

Sub-classes: CaretMode, QFlags_CaretMode, PatternSyntax, QFlags_PatternSyntax

Public constructors

new QRegExpnewConstructor QRegExp::QRegExp()
new QRegExpnew(string pattern,
const Qt_CaseSensitivity cs = Qt::CaseSensitive,
const QRegExp_PatternSyntax syntax = QRegExp::RegExp)
Constructor QRegExp::QRegExp(const QString &pattern, Qt::CaseSensitivity cs, QRegExp::PatternSyntax syntax)
new QRegExpnew(const QRegExp rx)Constructor QRegExp::QRegExp(const QRegExp &rx)

Public methods

[const]bool!=(const QRegExp rx)Method bool QRegExp::operator!=(const QRegExp &rx)
[const]bool==(const QRegExp rx)Method bool QRegExp::operator==(const QRegExp &rx)
void_assign(const QRegExp other)Assigns another object to self
[const]QRegExp ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
QRegExpassign(const QRegExp rx)Method QRegExp &QRegExp::operator=(const QRegExp &rx)
[const]stringcap(int nth = 0)Method QString QRegExp::cap(int nth)
stringcap(int nth = 0)Method QString QRegExp::cap(int nth)
[const]intcaptureCountMethod int QRegExp::captureCount()
[const]string[]capturedTextsMethod QStringList QRegExp::capturedTexts()
string[]capturedTextsMethod QStringList QRegExp::capturedTexts()
[const]Qt_CaseSensitivitycaseSensitivityMethod Qt::CaseSensitivity QRegExp::caseSensitivity()
voidcaseSensitivity=(const Qt_CaseSensitivity cs)Method void QRegExp::setCaseSensitivity(Qt::CaseSensitivity cs)
[const]new QRegExp ptrdupCreates a copy of self
[const]stringerrorStringMethod QString QRegExp::errorString()
stringerrorStringMethod QString QRegExp::errorString()
[const]boolexactMatch(string str)Method bool QRegExp::exactMatch(const QString &str)
[const]intindexIn(string str,
int offset = 0,
const QRegExp_CaretMode caretMode = QRegExp::CaretAtZero)
Method int QRegExp::indexIn(const QString &str, int offset, QRegExp::CaretMode caretMode)
[const]boolisEmpty?Method bool QRegExp::isEmpty()
[const]boolisMinimal?Method bool QRegExp::isMinimal()
[const]boolisValid?Method bool QRegExp::isValid()
[const]intlastIndexIn(string str,
int offset = -1,
const QRegExp_CaretMode caretMode = QRegExp::CaretAtZero)
Method int QRegExp::lastIndexIn(const QString &str, int offset, QRegExp::CaretMode caretMode)
[const]intmatchedLengthMethod int QRegExp::matchedLength()
[const]boolminimalMethod bool QRegExp::isMinimal()
voidminimal=(bool minimal)Method void QRegExp::setMinimal(bool minimal)
[const]stringpatternMethod QString QRegExp::pattern()
voidpattern=(string pattern)Method void QRegExp::setPattern(const QString &pattern)
[const]QRegExp_PatternSyntaxpatternSyntaxMethod QRegExp::PatternSyntax QRegExp::patternSyntax()
voidpatternSyntax=(const QRegExp_PatternSyntax syntax)Method void QRegExp::setPatternSyntax(QRegExp::PatternSyntax syntax)
[const]intpos(int nth = 0)Method int QRegExp::pos(int nth)
intpos(int nth = 0)Method int QRegExp::pos(int nth)
voidsetCaseSensitivity(const Qt_CaseSensitivity cs)Method void QRegExp::setCaseSensitivity(Qt::CaseSensitivity cs)
voidsetMinimal(bool minimal)Method void QRegExp::setMinimal(bool minimal)
voidsetPattern(string pattern)Method void QRegExp::setPattern(const QString &pattern)
voidsetPatternSyntax(const QRegExp_PatternSyntax syntax)Method void QRegExp::setPatternSyntax(QRegExp::PatternSyntax syntax)
voidswap(QRegExp other)Method void QRegExp::swap(QRegExp &other)

Public static methods and constants

[static,const]QRegExp_CaretModeCaretAtOffsetEnum constant QRegExp::CaretAtOffset
[static,const]QRegExp_CaretModeCaretAtZeroEnum constant QRegExp::CaretAtZero
[static,const]QRegExp_CaretModeCaretWontMatchEnum constant QRegExp::CaretWontMatch
[static,const]QRegExp_PatternSyntaxFixedStringEnum constant QRegExp::FixedString
[static,const]QRegExp_PatternSyntaxRegExpEnum constant QRegExp::RegExp
[static,const]QRegExp_PatternSyntaxRegExp2Enum constant QRegExp::RegExp2
[static,const]QRegExp_PatternSyntaxW3CXmlSchema11Enum constant QRegExp::W3CXmlSchema11
[static,const]QRegExp_PatternSyntaxWildcardEnum constant QRegExp::Wildcard
[static,const]QRegExp_PatternSyntaxWildcardUnixEnum constant QRegExp::WildcardUnix
stringescape(string str)Static method QString QRegExp::escape(const QString &str)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QRegExp rx)

Description: Method bool QRegExp::operator!=(const QRegExp &rx)

==

Signature: [const] bool == (const QRegExp rx)

Description: Method bool QRegExp::operator==(const QRegExp &rx)

CaretAtOffset

Signature: [static,const] QRegExp_CaretMode CaretAtOffset

Description: Enum constant QRegExp::CaretAtOffset

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

CaretAtZero

Signature: [static,const] QRegExp_CaretMode CaretAtZero

Description: Enum constant QRegExp::CaretAtZero

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

CaretWontMatch

Signature: [static,const] QRegExp_CaretMode CaretWontMatch

Description: Enum constant QRegExp::CaretWontMatch

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

FixedString

Signature: [static,const] QRegExp_PatternSyntax FixedString

Description: Enum constant QRegExp::FixedString

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

RegExp

Signature: [static,const] QRegExp_PatternSyntax RegExp

Description: Enum constant QRegExp::RegExp

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

RegExp2

Signature: [static,const] QRegExp_PatternSyntax RegExp2

Description: Enum constant QRegExp::RegExp2

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

W3CXmlSchema11

Signature: [static,const] QRegExp_PatternSyntax W3CXmlSchema11

Description: Enum constant QRegExp::W3CXmlSchema11

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

Wildcard

Signature: [static,const] QRegExp_PatternSyntax Wildcard

Description: Enum constant QRegExp::Wildcard

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

WildcardUnix

Signature: [static,const] QRegExp_PatternSyntax WildcardUnix

Description: Enum constant QRegExp::WildcardUnix

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

_assign

Signature: void _assign (const QRegExp other)

Description: Assigns another object to self

_const_cast

Signature: [const] QRegExp 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.

assign

Signature: QRegExp assign (const QRegExp rx)

Description: Method QRegExp &QRegExp::operator=(const QRegExp &rx)

cap

(1) Signature: [const] string cap (int nth = 0)

Description: Method QString QRegExp::cap(int nth)

(2) Signature: string cap (int nth = 0)

Description: Method QString QRegExp::cap(int nth)

captureCount

Signature: [const] int captureCount

Description: Method int QRegExp::captureCount()

capturedTexts

(1) Signature: [const] string[] capturedTexts

Description: Method QStringList QRegExp::capturedTexts()

(2) Signature: string[] capturedTexts

Description: Method QStringList QRegExp::capturedTexts()

caseSensitivity

Signature: [const] Qt_CaseSensitivity caseSensitivity

Description: Method Qt::CaseSensitivity QRegExp::caseSensitivity()

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

caseSensitivity=

Signature: void caseSensitivity= (const Qt_CaseSensitivity cs)

Description: Method void QRegExp::setCaseSensitivity(Qt::CaseSensitivity cs)

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

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 QRegExp ptr dup

Description: Creates a copy of self

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

errorString

(1) Signature: [const] string errorString

Description: Method QString QRegExp::errorString()

(2) Signature: string errorString

Description: Method QString QRegExp::errorString()

escape

Signature: [static] string escape (string str)

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

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

exactMatch

Signature: [const] bool exactMatch (string str)

Description: Method bool QRegExp::exactMatch(const QString &str)

indexIn

Signature: [const] int indexIn (string str, int offset = 0, const QRegExp_CaretMode caretMode = QRegExp::CaretAtZero)

Description: Method int QRegExp::indexIn(const QString &str, int offset, QRegExp::CaretMode caretMode)

isEmpty?

Signature: [const] bool isEmpty?

Description: Method bool QRegExp::isEmpty()

isMinimal?

Signature: [const] bool isMinimal?

Description: Method bool QRegExp::isMinimal()

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

isValid?

Signature: [const] bool isValid?

Description: Method bool QRegExp::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.

lastIndexIn

Signature: [const] int lastIndexIn (string str, int offset = -1, const QRegExp_CaretMode caretMode = QRegExp::CaretAtZero)

Description: Method int QRegExp::lastIndexIn(const QString &str, int offset, QRegExp::CaretMode caretMode)

matchedLength

Signature: [const] int matchedLength

Description: Method int QRegExp::matchedLength()

minimal

Signature: [const] bool minimal

Description: Method bool QRegExp::isMinimal()

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

minimal=

Signature: void minimal= (bool minimal)

Description: Method void QRegExp::setMinimal(bool minimal)

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

new

(1) Signature: [static] new QRegExp new

Description: Constructor QRegExp::QRegExp()

This method creates an object of class QRegExp.

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

(2) Signature: [static] new QRegExp new (string pattern, const Qt_CaseSensitivity cs = Qt::CaseSensitive, const QRegExp_PatternSyntax syntax = QRegExp::RegExp)

Description: Constructor QRegExp::QRegExp(const QString &pattern, Qt::CaseSensitivity cs, QRegExp::PatternSyntax syntax)

This method creates an object of class QRegExp.

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

(3) Signature: [static] new QRegExp new (const QRegExp rx)

Description: Constructor QRegExp::QRegExp(const QRegExp &rx)

This method creates an object of class QRegExp.

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

pattern

Signature: [const] string pattern

Description: Method QString QRegExp::pattern()

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

pattern=

Signature: void pattern= (string pattern)

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

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

patternSyntax

Signature: [const] QRegExp_PatternSyntax patternSyntax

Description: Method QRegExp::PatternSyntax QRegExp::patternSyntax()

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

patternSyntax=

Signature: void patternSyntax= (const QRegExp_PatternSyntax syntax)

Description: Method void QRegExp::setPatternSyntax(QRegExp::PatternSyntax syntax)

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

pos

(1) Signature: [const] int pos (int nth = 0)

Description: Method int QRegExp::pos(int nth)

(2) Signature: int pos (int nth = 0)

Description: Method int QRegExp::pos(int nth)

setCaseSensitivity

Signature: void setCaseSensitivity (const Qt_CaseSensitivity cs)

Description: Method void QRegExp::setCaseSensitivity(Qt::CaseSensitivity cs)

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

setMinimal

Signature: void setMinimal (bool minimal)

Description: Method void QRegExp::setMinimal(bool minimal)

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

setPattern

Signature: void setPattern (string pattern)

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

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

setPatternSyntax

Signature: void setPatternSyntax (const QRegExp_PatternSyntax syntax)

Description: Method void QRegExp::setPatternSyntax(QRegExp::PatternSyntax syntax)

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

swap

Signature: void swap (QRegExp other)

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