KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QStringMatcher

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QStringMatcher

Public constructors

new QStringMatchernewConstructor QStringMatcher::QStringMatcher()
new QStringMatchernew(string pattern,
const Qt_CaseSensitivity cs = Qt::CaseSensitive)
Constructor QStringMatcher::QStringMatcher(const QString &pattern, Qt::CaseSensitivity cs)
new QStringMatchernew(const QStringMatcher other)Constructor QStringMatcher::QStringMatcher(const QStringMatcher &other)

Public methods

void_assign(const QStringMatcher other)Assigns another object to self
[const]QStringMatcher 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.
QStringMatcherassign(const QStringMatcher other)Method QStringMatcher &QStringMatcher::operator=(const QStringMatcher &other)
[const]Qt_CaseSensitivitycaseSensitivityMethod Qt::CaseSensitivity QStringMatcher::caseSensitivity()
voidcaseSensitivity=(const Qt_CaseSensitivity cs)Method void QStringMatcher::setCaseSensitivity(Qt::CaseSensitivity cs)
[const]new QStringMatcher ptrdupCreates a copy of self
[const]intindexIn(string str,
int from = 0)
Method int QStringMatcher::indexIn(const QString &str, int from)
[const]stringpatternMethod QString QStringMatcher::pattern()
voidpattern=(string pattern)Method void QStringMatcher::setPattern(const QString &pattern)
voidsetCaseSensitivity(const Qt_CaseSensitivity cs)Method void QStringMatcher::setCaseSensitivity(Qt::CaseSensitivity cs)
voidsetPattern(string pattern)Method void QStringMatcher::setPattern(const QString &pattern)

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

_assign

Signature: void _assign (const QStringMatcher other)

Description: Assigns another object to self

_const_cast

Signature: [const] QStringMatcher 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: QStringMatcher assign (const QStringMatcher other)

Description: Method QStringMatcher &QStringMatcher::operator=(const QStringMatcher &other)

caseSensitivity

Signature: [const] Qt_CaseSensitivity caseSensitivity

Description: Method Qt::CaseSensitivity QStringMatcher::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 QStringMatcher::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 QStringMatcher ptr dup

Description: Creates a copy of self

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

indexIn

Signature: [const] int indexIn (string str, int from = 0)

Description: Method int QStringMatcher::indexIn(const QString &str, int from)

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.

new

(1) Signature: [static] new QStringMatcher new

Description: Constructor QStringMatcher::QStringMatcher()

This method creates an object of class QStringMatcher.

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

(2) Signature: [static] new QStringMatcher new (string pattern, const Qt_CaseSensitivity cs = Qt::CaseSensitive)

Description: Constructor QStringMatcher::QStringMatcher(const QString &pattern, Qt::CaseSensitivity cs)

This method creates an object of class QStringMatcher.

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

(3) Signature: [static] new QStringMatcher new (const QStringMatcher other)

Description: Constructor QStringMatcher::QStringMatcher(const QStringMatcher &other)

This method creates an object of class QStringMatcher.

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

pattern

Signature: [const] string pattern

Description: Method QString QStringMatcher::pattern()

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

pattern=

Signature: void pattern= (string pattern)

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

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

setCaseSensitivity

Signature: void setCaseSensitivity (const Qt_CaseSensitivity cs)

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

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

setPattern

Signature: void setPattern (string pattern)

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

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