Class: QgsStringReplacement

class qgis.core.QgsStringReplacement(match: str, replacement: str, caseSensitive: bool = False, wholeWordOnly: bool = False)

Bases: sip.wrapper

Constructor for QgsStringReplacement.

Parameters
  • match (str) – string to match

  • replacement (str) – string to replace match with

  • caseSensitive (bool = False) – set to True for a case sensitive match

  • wholeWordOnly (bool = False) – set to True to match complete words only, or False to allow partial word matches

QgsStringReplacement(QgsStringReplacement)

A representation of a single string replacement.

Methods

caseSensitive

Returns True if match is case sensitive

fromProperties

Creates a new QgsStringReplacement from an encoded properties map.

match

Returns the string matched by this object

process

Processes a given input string, applying any valid replacements which should be made.

properties

Returns a map of the replacement properties.

replacement

Returns the string to replace matches with

wholeWordOnly

Returns True if match only applies to whole words, or False if partial word matches are permitted

caseSensitive(self) → bool

Returns True if match is case sensitive

Return type

bool

fromProperties(properties: Dict[str, str]) → QgsStringReplacement

Creates a new QgsStringReplacement from an encoded properties map.

See also

properties()

Parameters

properties (Dict[str) –

Return type

QgsStringReplacement

match(self) → str

Returns the string matched by this object

Return type

str

process(self, input: str) → str

Processes a given input string, applying any valid replacements which should be made.

Parameters

input (str) – input string

Return type

str

Returns

input string with any matches replaced by replacement string

properties(self) → Dict[str, str]

Returns a map of the replacement properties.

See also

fromProperties()

Return type

Dict[str, str]

replacement(self) → str

Returns the string to replace matches with

Return type

str

wholeWordOnly(self) → bool

Returns True if match only applies to whole words, or False if partial word matches are permitted

Return type

bool