This file is indexed.

/usr/share/gtk-doc/html/rhythmbox/RBShellPreferences.html is in rhythmbox-doc 3.4.2-4ubuntu1.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RBShellPreferences: Rhythmbox Development Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch05.html" title="Shell">
<link rel="prev" href="RBShellPlayer.html" title="RBShellPlayer">
<link rel="next" href="RBShell.html" title="RBShell">
<meta name="generator" content="GTK-Doc V1.27 (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="5"><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="#RBShellPreferences.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#RBShellPreferences.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#RBShellPreferences.implemented-interfaces" class="shortcut">Implemented Interfaces</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="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="RBShellPlayer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="RBShell.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="RBShellPreferences"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RBShellPreferences.top_of_page"></a>RBShellPreferences</span></h2>
<p>RBShellPreferences — preferences dialog</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="RBShellPreferences.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="RBShellPreferences.html#rb-shell-preferences-new" title="rb_shell_preferences_new ()">rb_shell_preferences_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 class="link" href="RBShellPreferences.html#rb-shell-preferences-append-page" title="rb_shell_preferences_append_page ()">rb_shell_preferences_append_page</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="RBShellPreferences.html#rb-shell-preferences-add-widget" title="rb_shell_preferences_add_widget ()">rb_shell_preferences_add_widget</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="RBShellPreferences.html#rb-shell-preferences-remove-widget" title="rb_shell_preferences_remove_widget ()">rb_shell_preferences_remove_widget</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RBShellPreferences.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="RBShellPreferences.html#RBShellPrefsUILocation" title="enum RBShellPrefsUILocation">RBShellPrefsUILocation</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="RBShellPreferences.html#RBShellPreferences-struct" title="struct RBShellPreferences">RBShellPreferences</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="RBShellPreferences.html#RBShellPreferencesClass" title="struct RBShellPreferencesClass">RBShellPreferencesClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RBShellPreferences.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="../gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
            <span class="lineart">╰──</span> <a href="../gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
                <span class="lineart">╰──</span> <a href="../gtk3/GtkBin.html#GtkBin-struct">GtkBin</a>
                    <span class="lineart">╰──</span> <a href="../gtk3/GtkWindow.html#GtkWindow-struct">GtkWindow</a>
                        <span class="lineart">╰──</span> <a href="../gtk3/GtkDialog.html#GtkDialog-struct">GtkDialog</a>
                            <span class="lineart">╰──</span> RBShellPreferences
</pre>
</div>
<div class="refsect1">
<a name="RBShellPreferences.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
RBShellPreferences implements
 AtkImplementorIface and  <a href="../gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="RBShellPreferences.description"></a><h2>Description</h2>
<p>The preferences dialog is built around a <a href="../gtk3/GtkNotebook.html#GtkNotebook-struct"><span class="type">GtkNotebook</span></a> widget, with two built-in
pages and additional pages for various sources.</p>
<p>The 'general' preferences page controls the set of browser views that are visible
(artist and album; genre and artist; or genre, artist, and album), the columns
that are visible, and the appearance of buttons in the main toolbar.  The browser
and column settings apply to all sources.</p>
<p>The 'playback' preferences page controls whether the crossfading player backend is used,
and if enabled, the crossfade duration and network buffer size.</p>
<p>Currently, the library and podcast sources add pages to the notebook, for configuring the
location and layout of the library and the podcast download location and update frequency.</p>
</div>
<div class="refsect1">
<a name="RBShellPreferences.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="rb-shell-preferences-new"></a><h3>rb_shell_preferences_new ()</h3>
<pre class="programlisting"><a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
rb_shell_preferences_new (<em class="parameter"><code><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *views</code></em>);</pre>
<p>Creates the <a class="link" href="RBShellPreferences.html" title="RBShellPreferences"><span class="type">RBShellPreferences</span></a> instance, populating it with the
preferences pages for the sources in the list.</p>
<div class="refsect3">
<a name="rb-shell-preferences-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>views</p></td>
<td class="parameter_description"><p>list of sources to check for preferences pages. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> RB.Source][<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="rb-shell-preferences-new.returns"></a><h4>Returns</h4>
<p> the <a class="link" href="RBShellPreferences.html" title="RBShellPreferences"><span class="type">RBShellPreferences</span></a> instance</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-shell-preferences-append-page"></a><h3>rb_shell_preferences_append_page ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_shell_preferences_append_page (<em class="parameter"><code><a class="link" href="RBShellPreferences.html" title="RBShellPreferences"><span class="type">RBShellPreferences</span></a> *prefs</code></em>,
                                  <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                  <em class="parameter"><code><a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
<p>Appends a new page to the preferences dialog notebook.</p>
<div class="refsect3">
<a name="rb-shell-preferences-append-page.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>prefs</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBShellPreferences.html" title="RBShellPreferences"><span class="type">RBShellPreferences</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>name of the page to append</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>the <a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> to use as the contents of the page</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-shell-preferences-add-widget"></a><h3>rb_shell_preferences_add_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_shell_preferences_add_widget (<em class="parameter"><code><a class="link" href="RBShellPreferences.html" title="RBShellPreferences"><span class="type">RBShellPreferences</span></a> *prefs</code></em>,
                                 <em class="parameter"><code><a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *widget</code></em>,
                                 <em class="parameter"><code><a class="link" href="RBShellPreferences.html#RBShellPrefsUILocation" title="enum RBShellPrefsUILocation"><span class="type">RBShellPrefsUILocation</span></a> location</code></em>,
                                 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> expand</code></em>,
                                 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> fill</code></em>);</pre>
<p>Adds a widget to the preferences window.  See <a href="../gtk3/GtkBox.html#gtk-box-pack-start"><span class="type">gtk_box_pack_start</span></a> for
details on how the expand and fill parameters work.  This function can be
used to add widgets to the 'general' and 'playback' pages.</p>
<div class="refsect3">
<a name="rb-shell-preferences-add-widget.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>prefs</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBShellPreferences.html" title="RBShellPreferences"><span class="type">RBShellPreferences</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>the <a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> to insert into the preferences window</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>location</p></td>
<td class="parameter_description"><p>the location at which to insert the widget</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>expand</p></td>
<td class="parameter_description"><p>whether the widget should be given extra space</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fill</p></td>
<td class="parameter_description"><p>whether the widget should fill all space allocated to it</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-shell-preferences-remove-widget"></a><h3>rb_shell_preferences_remove_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_shell_preferences_remove_widget (<em class="parameter"><code><a class="link" href="RBShellPreferences.html" title="RBShellPreferences"><span class="type">RBShellPreferences</span></a> *prefs</code></em>,
                                    <em class="parameter"><code><a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *widget</code></em>,
                                    <em class="parameter"><code><a class="link" href="RBShellPreferences.html#RBShellPrefsUILocation" title="enum RBShellPrefsUILocation"><span class="type">RBShellPrefsUILocation</span></a> location</code></em>);</pre>
<p>Removes a widget added with <a class="link" href="RBShellPreferences.html#rb-shell-preferences-add-widget" title="rb_shell_preferences_add_widget ()"><span class="type">rb_shell_preferences_add_widget</span></a> from the preferences window.</p>
<div class="refsect3">
<a name="rb-shell-preferences-remove-widget.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>prefs</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBShellPreferences.html" title="RBShellPreferences"><span class="type">RBShellPreferences</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>the <a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> to remove from the preferences window</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>location</p></td>
<td class="parameter_description"><p>the UI location to which the widget was originally added</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="RBShellPreferences.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="RBShellPrefsUILocation"></a><h3>enum RBShellPrefsUILocation</h3>
<p>Locations available for adding new widgets to the preferences dialog.</p>
<div class="refsect3">
<a name="RBShellPrefsUILocation.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="RB-SHELL-PREFS-UI-LOCATION-GENERAL:CAPS"></a>RB_SHELL_PREFS_UI_LOCATION_GENERAL</p></td>
<td class="enum_member_description">
<p>The "general" preferences page</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RB-SHELL-PREFS-UI-LOCATION-PLAYBACK:CAPS"></a>RB_SHELL_PREFS_UI_LOCATION_PLAYBACK</p></td>
<td class="enum_member_description">
<p>THe "playback" preferences page</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="RBShellPreferences-struct"></a><h3>struct RBShellPreferences</h3>
<pre class="programlisting">struct RBShellPreferences;</pre>
</div>
<hr>
<div class="refsect2">
<a name="RBShellPreferencesClass"></a><h3>struct RBShellPreferencesClass</h3>
<pre class="programlisting">struct RBShellPreferencesClass {
	GtkDialogClass parent_class;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>