GI.GtkSource.Functions

Methods

utilsEscapeSearchText

utilsEscapeSearchText

Arguments

:: (HasCallStack, MonadIO m)

=> Text

text: the text to escape.

-> m Text

Returns: the escaped text.

Use this function to escape the following characters: \n, \r, \t and \.

For a regular expression search, use regexEscapeString instead.

One possible use case is to take the TextBuffer's selection and put it in a search entry. The selection can contain tabulations, newlines, etc. So it's better to escape those special characters to better fit in the search entry.

See also: utilsUnescapeSearchText.

<warning> Warning: the escape and unescape functions are not reciprocal! For example, escape (unescape (\)) = \. So avoid cycles such as: search entry -> unescape -> search settings -> escape -> search entry. The original search entry text may be modified. </warning>

Since: 3.10

utilsUnescapeSearchText

utilsUnescapeSearchText

Arguments

:: (HasCallStack, MonadIO m)

=> Text

text: the text to unescape.

-> m Text

Returns: the unescaped text.

Use this function before searchSettingsSetSearchText, to unescape the following sequences of characters: \n, \r, \t and \\. The purpose is to easily write those characters in a search entry.

Note that unescaping the search text is not needed for regular expression searches.

See also: utilsEscapeSearchText.

Since: 3.10