Class: QgsStringReplacementCollection

A collection of string replacements (specified using QgsStringReplacement objects).

Methods

process	Processes a given input string, applying any valid replacements which should be made using QgsStringReplacement objects contained by this collection.
readXml	Reads the collection state from an XML element.
replacements	Returns the list of string replacements in this collection.
setReplacements	Sets the list of string replacements in this collection.
writeXml	Writes the collection state to an XML element.

class qgis.core.QgsStringReplacementCollection

Bases: object

__init__(replacements: Iterable[QgsStringReplacement] = [])

Constructor for QgsStringReplacementCollection

Parameters:

replacements (Iterable[QgsStringReplacement] = []) – initial list of string replacements

__init__(a0: QgsStringReplacementCollection)

Parameters:

a0 (QgsStringReplacementCollection)

process(self, input: str | None) → str

Processes a given input string, applying any valid replacements which should be made using QgsStringReplacement objects contained by this collection. Replacements are made in order of the QgsStringReplacement objects contained in the collection.

Parameters:

input (Optional[str]) – input string

Return type:

str

Returns:

input string with any matches replaced by replacement string

readXml(self, elem: QDomElement)

Reads the collection state from an XML element.

Parameters:

elem (QDomElement) – DOM element

See also

writeXml()

replacements(self) → List[QgsStringReplacement]

Returns the list of string replacements in this collection.

See also

setReplacements()

Return type:

List[QgsStringReplacement]

setReplacements(self, replacements: Iterable[QgsStringReplacement])

Sets the list of string replacements in this collection.

Parameters:

replacements (Iterable[QgsStringReplacement]) – list of string replacements to apply. Replacements are applied in the order they are specified here.

See also

replacements()

writeXml(self, elem: QDomElement, doc: QDomDocument)

Writes the collection state to an XML element.

Parameters:

• elem (QDomElement) – target DOM element

• doc (QDomDocument) – DOM document

See also

readXml()