This file is indexed.

/usr/share/gtk-doc/html/libyelp/YelpLocationEntry.html is in libyelp-dev 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
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Yelp Reference Manual: YelpLocationEntry</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Yelp Reference Manual">
<link rel="up" href="ch01.html#id-1.2.2" title="Widgets">
<link rel="prev" href="YelpView.html" title="YelpView">
<link rel="next" href="ch01s02.html" title="Document Processing">
<meta name="generator" content="GTK-Doc V1.20 (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" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
                  <a href="#YelpLocationEntry.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#YelpLocationEntry.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 
                  <a href="#YelpLocationEntry.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 
                  <a href="#YelpLocationEntry.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> 
                  <a href="#YelpLocationEntry.signals" class="shortcut">Signals</a></span>
</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#id-1.2.2"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="YelpView.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch01s02.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="YelpLocationEntry"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="YelpLocationEntry.top_of_page"></a>YelpLocationEntry</span></h2>
<p>YelpLocationEntry — A location entry with history and search</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="YelpLocationEntry.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a href="YelpLocationEntry.html#yelp-location-entry-new">yelp_location_entry_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a href="YelpLocationEntry.html#yelp-location-entry-start-search">yelp_location_entry_start_search</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="YelpLocationEntry.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">YelpBookmarks</span> *</td>
<td class="property_name"><a href="YelpLocationEntry.html#YelpLocationEntry--bookmarks">bookmarks</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a href="YelpLocationEntry.html#YelpLocationEntry--enable-search">enable-search</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<a href="YelpView.html"><span class="type">YelpView</span></a> *</td>
<td class="property_name"><a href="YelpLocationEntry.html#YelpLocationEntry--view">view</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="YelpLocationEntry.signals"></a><h2>Signals</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a href="YelpLocationEntry.html#YelpLocationEntry-bookmark-clicked">bookmark-clicked</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a href="YelpLocationEntry.html#YelpLocationEntry-location-selected">location-selected</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a href="YelpLocationEntry.html#YelpLocationEntry-search-activated">search-activated</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="YelpLocationEntry.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a href="YelpLocationEntry.html#YelpLocationEntry-struct">YelpLocationEntry</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a href="YelpLocationEntry.html#YelpLocationEntryClass">YelpLocationEntryClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="YelpLocationEntry.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html">GtkWidget</a>
            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html">GtkContainer</a>
                <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkBin.html">GtkBin</a>
                    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkComboBox.html">GtkComboBox</a>
                        <span class="lineart">╰──</span> YelpLocationEntry
</pre>
</div>
<div class="refsect1">
<a name="YelpLocationEntry.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
YelpLocationEntry implements
 AtkImplementorIface,  <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html">GtkBuildable</a>,  <a href="/usr/share/gtk-doc/html/gtk3/GtkCellLayout.html">GtkCellLayout</a> and  <a href="/usr/share/gtk-doc/html/gtk3/GtkCellEditable.html">GtkCellEditable</a>.</p>
</div>
<div class="refsect1">
<a name="YelpLocationEntry.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;yelp.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="YelpLocationEntry.description"></a><h2>Description</h2>
<p><a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> is a <a href="/usr/share/gtk-doc/html/gtk3/GtkComboBox.html"><span class="type">GtkComboBox</span></a> designed to show the current location,
provide a drop-down menu of previous locations, and allow the user to perform
searches.</p>
<p>The <a href="/usr/share/gtk-doc/html/gtk3/GtkTreeModel.html"><span class="type">GtkTreeModel</span></a> used by a <a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> is expected to have at least
four columns: <span class="type">“entry-text-column”</span> contains the displayed name
of the location, <span class="type">“desc-column”</span> contains a description
for each entry, <span class="type">“icon-column”</span> contains an icon name for
the location, and <span class="type">“flags-column”</span> contains a bit field
of <span class="type">YelpLocationEntryFlags</span>.  These columns are specified when creating a
<a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> widget with <code class="function">yelp_location_entry_new_with_model()</code>.</p>
<p>Usually, a single row in the <a href="/usr/share/gtk-doc/html/gtk3/GtkTreeModel.html"><span class="type">GtkTreeModel</span></a> corresponds to a location.  When
a user selects a row from the drop-down menu, the icon and text for that
row will be placed in the embedded text entry, and the
<span class="type">“location-selected”</span> signal will be emitted.</p>
<p>If a row has the <code class="literal">YELP_LOCATION_ENTRY_IS_SEARCH</code> flag set, selecting that
row will not emit the <a href="YelpLocationEntry.html#YelpLocationEntry-location-selected"><span class="type">“location-selected”</span></a> signal.  Instead,
the <a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> widget will be placed into search mode, as if by a
call to <a href="YelpLocationEntry.html#yelp-location-entry-start-search"><code class="function">yelp_location_entry_start_search()</code></a>.</p>
<p>When a row has the <code class="literal">YELP_LOCATION_ENTRY_CAN_BOOKMARK</code> flag set, an icon
will be displayed in the secondary icon position of the embedded text
entry allowing the user to bookmark the location.  Clicking this icon
will cause the FIXME signal to be emitted.</p>
</div>
<div class="refsect1">
<a name="YelpLocationEntry.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="yelp-location-entry-new"></a><h3>yelp_location_entry_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
yelp_location_entry_new (<em class="parameter"><code><a href="YelpView.html"><span class="type">YelpView</span></a> *window</code></em>,
                         <em class="parameter"><code><span class="type">YelpBookmarks</span> *bookmarks</code></em>);</pre>
<p>Creates a new <a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> widget to control <em class="parameter"><code>view</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.2.3.11.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>view</p></td>
<td class="parameter_description"><p>A <a href="YelpView.html"><span class="type">YelpView</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.11.2.6"></a><h4>Returns</h4>
<p> A new <a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="yelp-location-entry-start-search"></a><h3>yelp_location_entry_start_search ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
yelp_location_entry_start_search (<em class="parameter"><code><a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> *entry</code></em>);</pre>
<p>Puts <em class="parameter"><code>entry</code></em>
 into search mode.  This focuses the entry and clears its text
contents.  When the user activates the search, the
<a href="YelpLocationEntry.html#YelpLocationEntry-search-activated"><span class="type">“search-activated”</span></a> signal will be emitted.</p>
<div class="refsect3">
<a name="id-1.2.2.3.11.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>A <a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="YelpLocationEntry.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="YelpLocationEntry-struct"></a><h3>struct YelpLocationEntry</h3>
<pre class="programlisting">struct YelpLocationEntry;</pre>
</div>
<hr>
<div class="refsect2">
<a name="YelpLocationEntryClass"></a><h3>struct YelpLocationEntryClass</h3>
<pre class="programlisting">struct YelpLocationEntryClass {
    GtkComboBoxClass     parent;

    void     (* location_selected)          (YelpLocationEntry *entry);
    void     (* search_activated)           (YelpLocationEntry *entry);
    void     (* bookmark_clicked)           (YelpLocationEntry *entry);

    /* Padding for future expansion */
    void (*_gtk_reserved0) (void);
    void (*_gtk_reserved1) (void);
    void (*_gtk_reserved2) (void);
    void (*_gtk_reserved3) (void);
};
</pre>
</div>
</div>
<div class="refsect1">
<a name="YelpLocationEntry.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="YelpLocationEntry--bookmarks"></a><h3>The <code class="literal">“bookmarks”</code> property</h3>
<pre class="programlisting">  “bookmarks”                <span class="type">YelpBookmarks</span> *</pre>
<p>An instance of an implementation of YelpBookmarks to provide
bookmark information for this location entry.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="YelpLocationEntry--enable-search"></a><h3>The <code class="literal">“enable-search”</code> property</h3>
<pre class="programlisting">  “enable-search”            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the location entry can act as a search entry.  If search is not
enabled, the user will not be able to initiate a search by clicking in
the embedded text entry or selecting a search row in the drop-down menu.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="YelpLocationEntry--view"></a><h3>The <code class="literal">“view”</code> property</h3>
<pre class="programlisting">  “view”                     <a href="YelpView.html"><span class="type">YelpView</span></a> *</pre>
<p>The YelpView instance that this location entry controls.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
<div class="refsect1">
<a name="YelpLocationEntry.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="YelpLocationEntry-bookmark-clicked"></a><h3>The <code class="literal">“bookmark-clicked”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> *widget,
               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)</pre>
<p>This signal will be emitted whenever a user clicks the bookmark icon
embedded in the location entry.</p>
<div class="refsect3">
<a name="id-1.2.2.3.14.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>The <a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> for which the signal was emitted.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User data set when the handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="YelpLocationEntry-location-selected"></a><h3>The <code class="literal">“location-selected”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> *widget,
               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)</pre>
<p>This signal will be emitted whenever a user selects a normal row from the
drop-down menu.  Note that if a row has the flag <code class="literal">YELP_LOCATION_ENTRY_IS_SEARCH</code>,
clicking the row will cause <em class="parameter"><code>widget</code></em>
 to enter search mode, and this signal
will not be emitted.</p>
<div class="refsect3">
<a name="id-1.2.2.3.14.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>The <a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> for which the signal was emitted.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User data set when the handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="YelpLocationEntry-search-activated"></a><h3>The <code class="literal">“search-activated”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> *widget,
               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>             *text,
               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)</pre>
<p>This signal will be emitted whenever the user activates a search, generally
by pressing <span class="keycap"><strong>Enter</strong></span> in the embedded text entry while <em class="parameter"><code>widget</code></em>

is in search mode.</p>
<div class="refsect3">
<a name="id-1.2.2.3.14.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>The <a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> for which the signal was emitted.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>The search text.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User data set when the handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>