rhythmbox-doc 3.4.2-4ubuntu1 / usr / share / gtk-doc / html / rhythmbox / rhythmbox-RBDeviceSource.html

This file is indexed.

/usr/share/gtk-doc/html/rhythmbox/rhythmbox-RBDeviceSource.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RBDeviceSource: 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="ch06.html" title="Sources">
<link rel="prev" href="RBStreamingSource.html" title="RBStreamingSource">
<link rel="next" href="rhythmbox-RBTransferTarget.html" title="RBTransferTarget">
<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="#rhythmbox-RBDeviceSource.description" class="shortcut">Description</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="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="RBStreamingSource.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="rhythmbox-RBTransferTarget.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="rhythmbox-RBDeviceSource"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="rhythmbox-RBDeviceSource.top_of_page"></a>RBDeviceSource</span></h2>
<p>RBDeviceSource — interface for sources based on physical devices</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="rhythmbox-RBDeviceSource.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="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="rhythmbox-RBDeviceSource.html#rb-device-source-can-eject" title="rb_device_source_can_eject ()">rb_device_source_can_eject</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="rhythmbox-RBDeviceSource.html#rb-device-source-eject" title="rb_device_source_eject ()">rb_device_source_eject</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="rhythmbox-RBDeviceSource.html#rb-device-source-want-uri" title="rb_device_source_want_uri ()">rb_device_source_want_uri</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="rhythmbox-RBDeviceSource.html#rb-device-source-uri-is-source" title="rb_device_source_uri_is_source ()">rb_device_source_uri_is_source</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="rhythmbox-RBDeviceSource.html#rb-device-source-set-display-details" title="rb_device_source_set_display_details ()">rb_device_source_set_display_details</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="rhythmbox-RBDeviceSource.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">struct</td>
<td class="function_name"><a class="link" href="rhythmbox-RBDeviceSource.html#RBDeviceSourceInterface" title="struct RBDeviceSourceInterface">RBDeviceSourceInterface</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="rhythmbox-RBDeviceSource.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;rb-device-source.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="rhythmbox-RBDeviceSource.description"></a><h2>Description</h2>
<p>Sources that represent physical devices should implement this interface.
It exposes the ability to eject the device, and also can be used to
implement some <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> methods by using details from a <a href="../gio/GVolume.html#GVolume-struct"><span class="type">GVolume</span></a> or
<a href="../gio/GMount.html#GMount-struct"><span class="type">GMount</span></a> accessed via 'volume' and 'mount' properties on the source object.
Devices that are not based on a <a href="../gio/GVolume.html#GVolume-struct"><span class="type">GVolume</span></a> or <a href="../gio/GMount.html#GMount-struct"><span class="type">GMount</span></a> can still use the
interface, but they must provide implementations of the <em class="parameter"><code>can_eject</code></em>
 and
<em class="parameter"><code>eject</code></em>
 methods.</p>
</div>
<div class="refsect1">
<a name="rhythmbox-RBDeviceSource.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="rb-device-source-can-eject"></a><h3>rb_device_source_can_eject ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rb_device_source_can_eject (<em class="parameter"><code><span class="type">RBDeviceSource</span> *source</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="rb-device-source-eject"></a><h3>rb_device_source_eject ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_device_source_eject (<em class="parameter"><code><span class="type">RBDeviceSource</span> *source</code></em>);</pre>
<p>Ejects the device that the source represents.</p>
<div class="refsect3">
<a name="rb-device-source-eject.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>source</p></td>
<td class="parameter_description"><p>a <span class="type">RBDeviceSource</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-device-source-want-uri"></a><h3>rb_device_source_want_uri ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
rb_device_source_want_uri (<em class="parameter"><code><a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> *source</code></em>,
                           <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
<p>Checks whether <em class="parameter"><code>uri</code></em>
 identifies a path underneath the
device's mount point.  Should be used to implement
the <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> want_uri method.</p>
<div class="refsect3">
<a name="rb-device-source-want-uri.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>source</p></td>
<td class="parameter_description"><p>a <span class="type">RBDeviceSource</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>a URI to consider</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="rb-device-source-want-uri.returns"></a><h4>Returns</h4>
<p> URI match strength</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-device-source-uri-is-source"></a><h3>rb_device_source_uri_is_source ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rb_device_source_uri_is_source (<em class="parameter"><code><a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> *source</code></em>,
                                <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
<p>Returns <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em>
 matches <em class="parameter"><code>source</code></em>
.  This should be
used to implement the uri_is_source <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> method.</p>
<div class="refsect3">
<a name="rb-device-source-uri-is-source.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>source</p></td>
<td class="parameter_description"><p>a <span class="type">RBDeviceSource</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>a URI to check</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="rb-device-source-uri-is-source.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em>
matches <em class="parameter"><code>source</code></em>
</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-device-source-set-display-details"></a><h3>rb_device_source_set_display_details ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_device_source_set_display_details (<em class="parameter"><code><span class="type">RBDeviceSource</span> *source</code></em>);</pre>
<p>Sets the icon and display name for a device-based source.
The details come from the mount and/or volume.  This should
be called in the source's constructed method.</p>
<div class="refsect3">
<a name="rb-device-source-set-display-details.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>source</p></td>
<td class="parameter_description"><p>a <span class="type">RBDeviceSource</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="rhythmbox-RBDeviceSource.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="RBDeviceSourceInterface"></a><h3>struct RBDeviceSourceInterface</h3>
<pre class="programlisting">struct RBDeviceSourceInterface {
	GTypeInterface g_iface;

	gboolean (*can_eject)		(RBDeviceSource *source);
	void		(*eject)		(RBDeviceSource *source);
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.