QgsStringReplacementCollection Class Reference

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

#include <qgsstringutils.h>

Public Member Functions
	QgsStringReplacementCollection (const QList< QgsStringReplacement > &replacements=QList< QgsStringReplacement >())
	Constructor for QgsStringReplacementCollection. More...
QString	process (const QString &input) const
	Processes a given input string, applying any valid replacements which should be made using QgsStringReplacement objects contained by this collection. More...
void	readXml (const QDomElement &elem)
	Reads the collection state from an XML element. More...
QList< QgsStringReplacement >	replacements () const
	Returns the list of string replacements in this collection. More...
void	setReplacements (const QList< QgsStringReplacement > &replacements)
	Sets the list of string replacements in this collection. More...
void	writeXml (QDomElement &elem, QDomDocument &doc) const
	Writes the collection state to an XML element. More...

Detailed Description

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

Since

QGIS 3.0

Definition at line 115 of file qgsstringutils.h.

Constructor & Destructor Documentation

QgsStringReplacementCollection()

QgsStringReplacementCollection::QgsStringReplacementCollection ( const QList< QgsStringReplacement > &  replacements = QList< QgsStringReplacement >() )

inline

Constructor for QgsStringReplacementCollection.

Parameters

replacements

initial list of string replacements

Definition at line 124 of file qgsstringutils.h.

Member Function Documentation

process()

QString QgsStringReplacementCollection::process

(

const QString &

input

)

const

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

input string

Returns

input string with any matches replaced by replacement string

Definition at line 727 of file qgsstringutils.cpp.

readXml()

void QgsStringReplacementCollection::readXml

(

const QDomElement &

elem

)

Reads the collection state from an XML element.

Parameters

elem	DOM element

See also

writeXml()

Definition at line 754 of file qgsstringutils.cpp.

replacements()

QList< QgsStringReplacement > QgsStringReplacementCollection::replacements ( ) const

inline

Returns the list of string replacements in this collection.

See also

setReplacements()

Definition at line 132 of file qgsstringutils.h.

setReplacements()

void QgsStringReplacementCollection::setReplacements ( const QList< QgsStringReplacement > &  replacements )

inline

Sets the list of string replacements in this collection.

Parameters

replacements

list of string replacements to apply. Replacements are applied in the order they are specified here.

See also

replacements()

Definition at line 140 of file qgsstringutils.h.

writeXml()

void QgsStringReplacementCollection::writeXml	(	QDomElement &	elem,
		QDomDocument &	doc
	)		const

Writes the collection state to an XML element.

Parameters

elem	target DOM element
doc	DOM document

See also

readXml()

Definition at line 738 of file qgsstringutils.cpp.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.20.0+99unstable/src/core/qgsstringutils.h
• /build/qgis-3.20.0+99unstable/src/core/qgsstringutils.cpp