This file is indexed.

/usr/share/gtk-doc/html/rhythmbox/RBTrackTransferQueue.html is in rhythmbox-doc 2.96-0ubuntu4.1.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RBTrackTransferQueue</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch05.html" title="Shell">
<link rel="prev" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch">
<link rel="next" href="ch06.html" title="Sources">
<meta name="generator" content="GTK-Doc V1.18 (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="RBTrackTransferBatch.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch05.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">Rhythmbox Development Reference Manual</th>
<td><a accesskey="n" href="ch06.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#RBTrackTransferQueue.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#RBTrackTransferQueue.description" class="shortcut">Description</a>
                   | 
                  <a href="#RBTrackTransferQueue.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#RBTrackTransferQueue.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#RBTrackTransferQueue.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="RBTrackTransferQueue"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RBTrackTransferQueue.top_of_page"></a>RBTrackTransferQueue</span></h2>
<p>RBTrackTransferQueue — track transfer queue and surrounding junk</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="RBTrackTransferQueue.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="RBTrackTransferQueue.html#RBTrackTransferQueue-struct" title="struct RBTrackTransferQueue">RBTrackTransferQueue</a>;
struct              <a class="link" href="RBTrackTransferQueue.html#RBTrackTransferQueueClass" title="struct RBTrackTransferQueueClass">RBTrackTransferQueueClass</a>;
<a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="returnvalue">RBTrackTransferQueue</span></a> * <a class="link" href="RBTrackTransferQueue.html#rb-track-transfer-queue-new" title="rb_track_transfer_queue_new ()">rb_track_transfer_queue_new</a>      (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="RBTrackTransferQueue.html#rb-track-transfer-queue-start-batch" title="rb_track_transfer_queue_start_batch ()">rb_track_transfer_queue_start_batch</a> (<em class="parameter"><code><a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a> *queue</code></em>,
                                                         <em class="parameter"><code><a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> *batch</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="RBTrackTransferQueue.html#rb-track-transfer-queue-cancel-batch" title="rb_track_transfer_queue_cancel_batch ()">rb_track_transfer_queue_cancel_batch</a>
                                                        (<em class="parameter"><code><a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a> *queue</code></em>,
                                                         <em class="parameter"><code><a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> *batch</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBTrackTransferQueue.html#rb-track-transfer-queue-get-status" title="rb_track_transfer_queue_get_status ()">rb_track_transfer_queue_get_status</a>  (<em class="parameter"><code><a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a> *queue</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **text</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **progress_text</code></em>,
                                                         <em class="parameter"><code><span class="type">float</span> *progress</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> *time_left</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="RBTrackTransferQueue.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----RBTrackTransferQueue
</pre>
</div>
<div class="refsect1">
<a name="RBTrackTransferQueue.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="RBTrackTransferQueue.html#RBTrackTransferQueue--batch" title='The "batch" property'>batch</a>"                    <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a>*  : Read
  "<a class="link" href="RBTrackTransferQueue.html#RBTrackTransferQueue--shell" title='The "shell" property'>shell</a>"                    <a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a>*              : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="RBTrackTransferQueue.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="RBTrackTransferQueue.html#RBTrackTransferQueue-missing-plugins" title='The "missing-plugins" signal'>missing-plugins</a>"                                : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  "<a class="link" href="RBTrackTransferQueue.html#RBTrackTransferQueue-transfer-progress" title='The "transfer-progress" signal'>transfer-progress</a>"                              : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="RBTrackTransferQueue.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="RBTrackTransferQueue.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="RBTrackTransferQueue-struct"></a><h3>struct RBTrackTransferQueue</h3>
<pre class="programlisting">struct RBTrackTransferQueue;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferQueueClass"></a><h3>struct RBTrackTransferQueueClass</h3>
<pre class="programlisting">struct RBTrackTransferQueueClass {
	GObjectClass parent_class;

	/* signals */
	void (*transfer_progress) (RBTrackTransferQueue *queue,
					 int done,
					 int total,
					 double fraction,
					 int time_left);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="rb-track-transfer-queue-new"></a><h3>rb_track_transfer_queue_new ()</h3>
<pre class="programlisting"><a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="returnvalue">RBTrackTransferQueue</span></a> * rb_track_transfer_queue_new      (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>);</pre>
<p>
Creates the <a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a> instance
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>the <a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-track-transfer-queue-start-batch"></a><h3>rb_track_transfer_queue_start_batch ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                rb_track_transfer_queue_start_batch (<em class="parameter"><code><a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a> *queue</code></em>,
                                                         <em class="parameter"><code><a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> *batch</code></em>);</pre>
<p>
Adds a new transfer batch to the transfer queue; if the queue is currently
empty, the transfer will start immediately, but not before the call returns.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>queue</code></em> :</span></p></td>
<td>the <a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>batch</code></em> :</span></p></td>
<td>the <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> to add to the queue</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-track-transfer-queue-cancel-batch"></a><h3>rb_track_transfer_queue_cancel_batch ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                rb_track_transfer_queue_cancel_batch
                                                        (<em class="parameter"><code><a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a> *queue</code></em>,
                                                         <em class="parameter"><code><a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> *batch</code></em>);</pre>
<p>
Removes a transfer batch from the queue.  If an entry from the
batch is currently being transferred, the transfer will be
aborted.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>queue</code></em> :</span></p></td>
<td>the <a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>batch</code></em> :</span></p></td>
<td>the <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> to cancel, or NULL for the current batch</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-track-transfer-queue-get-status"></a><h3>rb_track_transfer_queue_get_status ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_track_transfer_queue_get_status  (<em class="parameter"><code><a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a> *queue</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **text</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **progress_text</code></em>,
                                                         <em class="parameter"><code><span class="type">float</span> *progress</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> *time_left</code></em>);</pre>
<p>
Retrieves transfer status information.  Works similarly to
<span class="type">rb_source_get_status</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>queue</code></em> :</span></p></td>
<td>the <a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>returns the status bar text</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>progress_text</code></em> :</span></p></td>
<td>returns the progress bar text</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
<td>returns the progress fraction</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>time_left</code></em> :</span></p></td>
<td>returns the estimated number of seconds remaining</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if transfer status information is returned</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="RBTrackTransferQueue.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="RBTrackTransferQueue--batch"></a><h3>The <code class="literal">"batch"</code> property</h3>
<pre class="programlisting">  "batch"                    <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a>*  : Read</pre>
<p>
The current <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> being processed
</p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferQueue--shell"></a><h3>The <code class="literal">"shell"</code> property</h3>
<pre class="programlisting">  "shell"                    <a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a>*              : Read / Write / Construct Only</pre>
<p>
The <a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a>
</p>
</div>
</div>
<div class="refsect1">
<a name="RBTrackTransferQueue.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="RBTrackTransferQueue-missing-plugins"></a><h3>The <code class="literal">"missing-plugins"</code> signal</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a> *queue,
                                                        <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html#GStrv"><span class="type">GStrv</span></a>                 details,
                                                        <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html#GStrv"><span class="type">GStrv</span></a>                 descriptions,
                                                        <a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a>             *closure,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              user_data)         : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Emitted to request installation of one or more encoder plugins for a
destination media format.  When the closure included in the signal args
is called, the transfer batch will be started.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>queue</code></em> :</span></p></td>
<td>the <a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>details</code></em> :</span></p></td>
<td>the list of plugin detail strings describing the missing plugins</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>descriptions</code></em> :</span></p></td>
<td>the list of descriptions for the missing plugins</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>closure</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> to be called when the plugin installation is complete</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferQueue-transfer-progress"></a><h3>The <code class="literal">"transfer-progress"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a> *queue,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  done,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  total,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               fraction,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  time_left,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              user_data)      : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Emitted regularly to convey progress information.  At the end of any given
transfer batch, there will be one signal emission with <em class="parameter"><code>done</code></em> == <em class="parameter"><code>total</code></em> and
<em class="parameter"><code>fraction</code></em> == 1.0.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>queue</code></em> :</span></p></td>
<td>the <a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>done</code></em> :</span></p></td>
<td>the number of entries transferred</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>total</code></em> :</span></p></td>
<td>the total number of entries in the batch</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fraction</code></em> :</span></p></td>
<td>the fraction of the batch that has been transferred</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>time_left</code></em> :</span></p></td>
<td>the estimated remaining time (in seconds)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>