API reference - Class QRegExp

Notation used in Ruby API documentation

Description: Binding of QRegExp

Sub-classes: CaretMode, 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
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]intnumCapturesMethod int QRegExp::numCaptures()
[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)

Public static methods and constants

[static,const]new QRegExp_CaretMode ptrCaretAtOffsetEnum constant QRegExp::CaretAtOffset
[static,const]new QRegExp_CaretMode ptrCaretAtZeroEnum constant QRegExp::CaretAtZero
[static,const]new QRegExp_CaretMode ptrCaretWontMatchEnum constant QRegExp::CaretWontMatch
[static,const]new QRegExp_PatternSyntax ptrFixedStringEnum constant QRegExp::FixedString
[static,const]new QRegExp_PatternSyntax ptrRegExpEnum constant QRegExp::RegExp
[static,const]new QRegExp_PatternSyntax ptrRegExp2Enum constant QRegExp::RegExp2
[static,const]new QRegExp_PatternSyntax ptrW3CXmlSchema11Enum constant QRegExp::W3CXmlSchema11
[static,const]new QRegExp_PatternSyntax ptrWildcardEnum constant QRegExp::Wildcard
[static,const]new QRegExp_PatternSyntax ptrWildcardUnixEnum 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

[const] bool !=(const QRegExp rx)

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

[const] bool ==(const QRegExp rx)

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

[static,const] new QRegExp_CaretMode ptr CaretAtOffset

Description: Enum constant QRegExp::CaretAtOffset

[static,const] new QRegExp_CaretMode ptr CaretAtZero

Description: Enum constant QRegExp::CaretAtZero

[static,const] new QRegExp_CaretMode ptr CaretWontMatch

Description: Enum constant QRegExp::CaretWontMatch

[static,const] new QRegExp_PatternSyntax ptr FixedString

Description: Enum constant QRegExp::FixedString

[static,const] new QRegExp_PatternSyntax ptr RegExp

Description: Enum constant QRegExp::RegExp

[static,const] new QRegExp_PatternSyntax ptr RegExp2

Description: Enum constant QRegExp::RegExp2

[static,const] new QRegExp_PatternSyntax ptr W3CXmlSchema11

Description: Enum constant QRegExp::W3CXmlSchema11

[static,const] new QRegExp_PatternSyntax ptr Wildcard

Description: Enum constant QRegExp::Wildcard

[static,const] new QRegExp_PatternSyntax ptr WildcardUnix

Description: Enum constant QRegExp::WildcardUnix

void _assign(const QRegExp other)

Description: Assigns another object to self

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.

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.

[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.

[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.

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.

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.

QRegExp assign(const QRegExp rx)

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

[const] string cap(int nth = 0)

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

string cap(int nth = 0)

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

[const] int captureCount

Description: Method int QRegExp::captureCount()

[const] string[] capturedTexts

Description: Method QStringList QRegExp::capturedTexts()

string[] capturedTexts

Description: Method QStringList QRegExp::capturedTexts()

[const] Qt_CaseSensitivity caseSensitivity

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

Python specific notes:

The object exposes a readable attribute 'caseSensitivity'. This is the getter.

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.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[const] new QRegExp ptr dup

Description: Creates a copy of self

[const] string errorString

Description: Method QString QRegExp::errorString()

string errorString

Description: Method QString QRegExp::errorString()

[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.

[const] bool exactMatch(string str)

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

[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)

[const] bool isEmpty?

Description: Method bool QRegExp::isEmpty()

[const] bool isMinimal?

Description: Method bool QRegExp::isMinimal()

Python specific notes:

The object exposes a readable attribute 'minimal'. This is the getter.

[const] bool isValid?

Description: Method bool QRegExp::isValid()

[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

[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)

[const] int matchedLength

Description: Method int QRegExp::matchedLength()

[const] bool minimal

Description: Method bool QRegExp::isMinimal()

Python specific notes:

The object exposes a readable attribute 'minimal'. This is the getter.

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.

[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

[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

[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

[const] int numCaptures

Description: Method int QRegExp::numCaptures()

[const] string pattern

Description: Method QString QRegExp::pattern()

Python specific notes:

The object exposes a readable attribute 'pattern'. This is the getter.

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.

[const] QRegExp_PatternSyntax patternSyntax

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

Python specific notes:

The object exposes a readable attribute 'patternSyntax'. This is the getter.

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.

[const] int pos(int nth = 0)

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

int pos(int nth = 0)

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

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.

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.

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.

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.