Class: QgsStringReplacement¶
-
class
qgis.core.
QgsStringReplacement
(match: str, replacement: str, caseSensitive: bool = False, wholeWordOnly: bool = False)¶ Bases:
sip.wrapper
Constructor for QgsStringReplacement.
- Parameters
match – string to match
replacement – string to replace match with
caseSensitive – set to true for a case sensitive match
wholeWordOnly – set to true to match complete words only, or false to allow partial word matches
QgsStringReplacement(QgsStringReplacement)
A representation of a single string replacement.
New in version 3.0: Enums
Methods
Returns true if match is case sensitive
Creates a new QgsStringReplacement from an encoded properties map.
Returns the string matched by this object
Processes a given input string, applying any valid replacements which should be made.
Returns a map of the replacement properties.
Returns the string to replace matches with
Returns true if match only applies to whole words, or false if partial word matches are permitted
Signals
Attributes
-
caseSensitive
(self) → bool¶ Returns true if match is case sensitive
-
fromProperties
(properties: Dict[str, str]) → QgsStringReplacement¶ Creates a new QgsStringReplacement from an encoded properties map.
See also
-
match
(self) → str¶ Returns the string matched by this object
-
process
(self, input: str) → str¶ Processes a given input string, applying any valid replacements which should be made.
- Parameters
input – input string
- Returns
input string with any matches replaced by replacement string
-
properties
(self) → Dict[str, str]¶ Returns a map of the replacement properties.
See also
-
replacement
(self) → str¶ Returns the string to replace matches with
-
wholeWordOnly
(self) → bool¶ Returns true if match only applies to whole words, or false if partial word matches are permitted