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
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
-
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
- Parameters
properties (Dict[str) –
- Return type
-
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
- 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