One possible use case is to take the gtk.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.
<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>
Use this function to escape the following characters: \n, \r, \t and \.
For a regular expression search, use Regex.escapeString instead.
One possible use case is to take the gtk.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: Source.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>