This file is indexed.

/usr/share/gtk-doc/html/gtksourceview-2.0/gtksourceview-2.0-Searching-in-a-GtkSourceBuffer.html is in libgtksourceview2.0-doc 2.10.5-2ubuntu2.

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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSourceIter</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GtkSourceView 2 Reference Manual">
<link rel="up" href="rn01.html" title="API reference">
<link rel="prev" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider">
<link rel="next" href="GtkSourceGutter.html" title="GtkSourceGutter">
<meta name="generator" content="GTK-Doc V1.15 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkSourceCompletionProvider.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="rn01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GtkSourceView 2 Reference Manual</th>
<td><a accesskey="n" href="GtkSourceGutter.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gtksourceview-2.0-Searching-in-a-GtkSourceBuffer.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#gtksourceview-2.0-Searching-in-a-GtkSourceBuffer.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="GtkSourceIter">
<a name="gtksourceview-2.0-Searching-in-a-GtkSourceBuffer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gtksourceview-2.0-Searching-in-a-GtkSourceBuffer.top_of_page"></a>GtkSourceIter</span></h2>
<p>GtkSourceIter — Improved search support in a <a class="link" href="GtkSourceBuffer.html" title="GtkSourceBuffer"><span class="type">GtkSourceBuffer</span></a></p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="gtksourceview-2.0-Searching-in-a-GtkSourceBuffer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;gtksourceview/gtksourceiter.h&gt;

enum                <a class="link" href="gtksourceview-2.0-Searching-in-a-GtkSourceBuffer.html#GtkSourceSearchFlags" title="enum GtkSourceSearchFlags">GtkSourceSearchFlags</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gtksourceview-2.0-Searching-in-a-GtkSourceBuffer.html#gtk-source-iter-backward-search" title="gtk_source_iter_backward_search ()">gtk_source_iter_backward_search</a>     (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gtksourceview-2.0-Searching-in-a-GtkSourceBuffer.html#GtkSourceSearchFlags" title="enum GtkSourceSearchFlags"><span class="type">GtkSourceSearchFlags</span></a> flags</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *match_start</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *match_end</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *limit</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gtksourceview-2.0-Searching-in-a-GtkSourceBuffer.html#gtk-source-iter-forward-search" title="gtk_source_iter_forward_search ()">gtk_source_iter_forward_search</a>      (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gtksourceview-2.0-Searching-in-a-GtkSourceBuffer.html#GtkSourceSearchFlags" title="enum GtkSourceSearchFlags"><span class="type">GtkSourceSearchFlags</span></a> flags</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *match_start</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *match_end</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *limit</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="gtksourceview-2.0-Searching-in-a-GtkSourceBuffer.description"></a><h2>Description</h2>
</div>
<div class="refsect1" title="Details">
<a name="gtksourceview-2.0-Searching-in-a-GtkSourceBuffer.details"></a><h2>Details</h2>
<div class="refsect2" title="enum GtkSourceSearchFlags">
<a name="GtkSourceSearchFlags"></a><h3>enum GtkSourceSearchFlags</h3>
<pre class="programlisting">typedef enum
{
	GTK_SOURCE_SEARCH_VISIBLE_ONLY		 = 1 &lt;&lt; 0,
	GTK_SOURCE_SEARCH_TEXT_ONLY		 = 1 &lt;&lt; 1,
	GTK_SOURCE_SEARCH_CASE_INSENSITIVE	 = 1 &lt;&lt; 2
	/* Possible future plans: SEARCH_REGEXP */
} GtkSourceSearchFlags;
</pre>
</div>
<hr>
<div class="refsect2" title="gtk_source_iter_backward_search ()">
<a name="gtk-source-iter-backward-search"></a><h3>gtk_source_iter_backward_search ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_source_iter_backward_search     (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gtksourceview-2.0-Searching-in-a-GtkSourceBuffer.html#GtkSourceSearchFlags" title="enum GtkSourceSearchFlags"><span class="type">GtkSourceSearchFlags</span></a> flags</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *match_start</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *match_end</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *limit</code></em>);</pre>
<p>
Same as <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#gtk-text-iter-backward-search"><code class="function">gtk_text_iter_backward_search()</code></a>, but supports case insensitive
searching.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> where the search begins.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
<td>search string.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>bitmask of flags affecting the search.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>match_start</code></em> :</span></p></td>
<td>return location for start of match, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>match_end</code></em> :</span></p></td>
<td>return location for end of match, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>limit</code></em> :</span></p></td>
<td>location of last possible <em class="parameter"><code>match_start</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for start of buffer.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> whether a match was found.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gtk_source_iter_forward_search ()">
<a name="gtk-source-iter-forward-search"></a><h3>gtk_source_iter_forward_search ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_source_iter_forward_search      (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gtksourceview-2.0-Searching-in-a-GtkSourceBuffer.html#GtkSourceSearchFlags" title="enum GtkSourceSearchFlags"><span class="type">GtkSourceSearchFlags</span></a> flags</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *match_start</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *match_end</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *limit</code></em>);</pre>
<p>
Searches forward for <em class="parameter"><code>str</code></em>. Any match is returned by setting
<em class="parameter"><code>match_start</code></em> to the first character of the match and <em class="parameter"><code>match_end</code></em> to the
first character after the match. The search will not continue past
<em class="parameter"><code>limit</code></em>. Note that a search is a linear or O(n) operation, so you
may wish to use <em class="parameter"><code>limit</code></em> to avoid locking up your UI on large
buffers.
</p>
<p>
If the <span class="type">GTK_SOURCE_SEARCH_VISIBLE_ONLY</span> flag is present, the match may
have invisible text interspersed in <em class="parameter"><code>str</code></em>. i.e. <em class="parameter"><code>str</code></em> will be a
possibly-noncontiguous subsequence of the matched range. similarly,
if you specify <span class="type">GTK_SOURCE_SEARCH_TEXT_ONLY</span>, the match may have
pixbufs or child widgets mixed inside the matched range. If these
flags are not given, the match must be exact; the special 0xFFFC
character in <em class="parameter"><code>str</code></em> will match embedded pixbufs or child widgets.
If you specify the <span class="type">GTK_SOURCE_SEARCH_CASE_INSENSITIVE</span> flag, the text will
be matched regardless of what case it is in.
</p>
<p>
Same as <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#gtk-text-iter-forward-search"><code class="function">gtk_text_iter_forward_search()</code></a>, but supports case insensitive
searching.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>start of search.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
<td>a search string.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>flags affecting how the search is done.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>match_start</code></em> :</span></p></td>
<td>return location for start of match, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>match_end</code></em> :</span></p></td>
<td>return location for end of match, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>limit</code></em> :</span></p></td>
<td>bound for the search, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the end of the buffer.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> whether a match was found.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="gtksourceview-2.0-Searching-in-a-GtkSourceBuffer.see-also"></a><h2>See Also</h2>
<a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>