/usr/share/gtk-doc/html/gtksourceview-3.0/gtksourceview-3.0-GtkSourceUtils.html is in libgtksourceview-3.0-doc 3.10.2-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSourceView 3 Reference Manual: GtkSourceUtils</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GtkSourceView 3 Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="GtkSourceUndoManager.html" title="GtkSourceUndoManager">
<link rel="next" href="GtkSourceView.html" title="GtkSourceView">
<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
|
<a href="#gtksourceview-3.0-GtkSourceUtils.description" class="shortcut">Description</a>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkSourceUndoManager.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkSourceView.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gtksourceview-3.0-GtkSourceUtils"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gtksourceview-3.0-GtkSourceUtils.top_of_page"></a>GtkSourceUtils</span></h2>
<p>GtkSourceUtils — Utilities functions</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gtksourceview-3.0-GtkSourceUtils.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gtksourceview/gtksource.h>
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gtksourceview-3.0-GtkSourceUtils.html#gtk-source-utils-unescape-search-text" title="gtk_source_utils_unescape_search_text ()">gtk_source_utils_unescape_search_text</a>
(<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gtksourceview-3.0-GtkSourceUtils.html#gtk-source-utils-escape-search-text" title="gtk_source_utils_escape_search_text ()">gtk_source_utils_escape_search_text</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="gtksourceview-3.0-GtkSourceUtils.description"></a><h2>Description</h2>
<p>
Utilities functions.
</p>
</div>
<div class="refsect1">
<a name="gtksourceview-3.0-GtkSourceUtils.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gtk-source-utils-unescape-search-text"></a><h3>gtk_source_utils_unescape_search_text ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gtk_source_utils_unescape_search_text
(<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
<p>
Use this function before <a class="link" href="GtkSourceSearchSettings.html#gtk-source-search-settings-set-search-text" title="gtk_source_search_settings_set_search_text ()"><code class="function">gtk_source_search_settings_set_search_text()</code></a>, to
unescape the following sequences of characters: \n, \r, \t and \\.
The purpose is to easily write those characters in a search entry.
</p>
<p>
Note that unescaping the search text is not needed for regular expression
searches.
</p>
<p>
See also: <a class="link" href="gtksourceview-3.0-GtkSourceUtils.html#gtk-source-utils-escape-search-text" title="gtk_source_utils_escape_search_text ()"><code class="function">gtk_source_utils_escape_search_text()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>the text to unescape.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the unescaped <em class="parameter"><code>text</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-utils-escape-search-text"></a><h3>gtk_source_utils_escape_search_text ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gtk_source_utils_escape_search_text (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
<p>
Use this function to escape the following characters: \n, \r, \t and \.
</p>
<p>
For a regular expression search, use <a href="/usr/share/gtk-doc/html/glib/glib-Perl-compatible-regular-expressions.html#g-regex-escape-string"><code class="function">g_regex_escape_string()</code></a> instead.
</p>
<p>
One possible use case is to take the <a href="/usr/share/gtk-doc/html/gtk3/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a>'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.
</p>
<p>
See also: <a class="link" href="gtksourceview-3.0-GtkSourceUtils.html#gtk-source-utils-unescape-search-text" title="gtk_source_utils_unescape_search_text ()"><code class="function">gtk_source_utils_unescape_search_text()</code></a>.
</p>
<p>
</p>
<div class="warning">
<h3 class="title">Warning</h3>
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.
</div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>the text to escape.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the escaped <em class="parameter"><code>text</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.10</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19.1</div>
</body>
</html>
|