← Back to branch summary

~ubuntu-branches/ubuntu/quantal/rhythmbox/quantal-proposed

« back to all changes in this revision

Viewing changes to doc/reference/html/rhythmbox-rb-file-helpers.html

  • Committer: Package Import Robot
  • Author(s): Didier Roche
  • Date: 2012-01-17 16:56:40 UTC
  • mfrom: (1.1.62)
  • Revision ID: package-import@ubuntu.com-20120117165640-pr034mkhmti3efh6
Tags: 2.95-0ubuntu1
https://launchpad.net/bugs/461279
* New upstream release:
  - wrong shortcut for Show / Hide the Queue Sidebar (LP: #461279)
* debian/watch:
  - update to latest url    
* debian/patches/00_fix_for_glib_2.32.patch:
  - was taken upstream, removed

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/rhythmbox-rb-file-helpers.html
8
8
<link rel="up" href="ch02.html" title="Lib">
9
9
<link rel="prev" href="rhythmbox-rb-debug.html" title="rb-debug">
10
10
<link rel="next" href="rhythmbox-rb-builder-helpers.html" title="rb-builder-helpers">
11
 
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
43
43
const <span class="returnvalue">char</span> *        <a class="link" href="rhythmbox-rb-file-helpers.html#rb-music-dir" title="rb_music_dir ()">rb_music_dir</a>                        (<em class="parameter"><code><span class="type">void</span></code></em>);
44
44
<span class="returnvalue">char</span> *              <a class="link" href="rhythmbox-rb-file-helpers.html#rb-find-user-data-file" title="rb_find_user_data_file ()">rb_find_user_data_file</a>              (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
45
45
<span class="returnvalue">char</span> *              <a class="link" href="rhythmbox-rb-file-helpers.html#rb-find-user-cache-file" title="rb_find_user_cache_file ()">rb_find_user_cache_file</a>             (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
46
 
<span class="returnvalue">void</span>                <a class="link" href="rhythmbox-rb-file-helpers.html#rb-file-helpers-init" title="rb_file_helpers_init ()">rb_file_helpers_init</a>                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> uninstalled</code></em>);
 
46
<span class="returnvalue">void</span>                <a class="link" href="rhythmbox-rb-file-helpers.html#rb-file-helpers-init" title="rb_file_helpers_init ()">rb_file_helpers_init</a>                (<em class="parameter"><code><span class="type">gboolean</span> uninstalled</code></em>);
47
47
<span class="returnvalue">void</span>                <a class="link" href="rhythmbox-rb-file-helpers.html#rb-file-helpers-shutdown" title="rb_file_helpers_shutdown ()">rb_file_helpers_shutdown</a>            (<em class="parameter"><code><span class="type">void</span></code></em>);
48
48
<span class="returnvalue">char</span> *              <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-resolve-symlink" title="rb_uri_resolve_symlink ()">rb_uri_resolve_symlink</a>              (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
49
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
50
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-is-directory" title="rb_uri_is_directory ()">rb_uri_is_directory</a>                 (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
51
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-exists" title="rb_uri_exists ()">rb_uri_exists</a>                       (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
52
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-is-readable" title="rb_uri_is_readable ()">rb_uri_is_readable</a>                  (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
53
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-is-writable" title="rb_uri_is_writable ()">rb_uri_is_writable</a>                  (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
54
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-is-local" title="rb_uri_is_local ()">rb_uri_is_local</a>                     (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
55
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-is-hidden" title="rb_uri_is_hidden ()">rb_uri_is_hidden</a>                    (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
56
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-could-be-podcast" title="rb_uri_could_be_podcast ()">rb_uri_could_be_podcast</a>             (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
57
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *is_opml</code></em>);
 
49
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
50
<span class="returnvalue">gboolean</span>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-is-directory" title="rb_uri_is_directory ()">rb_uri_is_directory</a>                 (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
 
51
<span class="returnvalue">gboolean</span>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-exists" title="rb_uri_exists ()">rb_uri_exists</a>                       (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
 
52
<span class="returnvalue">gboolean</span>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-is-readable" title="rb_uri_is_readable ()">rb_uri_is_readable</a>                  (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
 
53
<span class="returnvalue">gboolean</span>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-is-writable" title="rb_uri_is_writable ()">rb_uri_is_writable</a>                  (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
 
54
<span class="returnvalue">gboolean</span>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-is-local" title="rb_uri_is_local ()">rb_uri_is_local</a>                     (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
 
55
<span class="returnvalue">gboolean</span>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-is-hidden" title="rb_uri_is_hidden ()">rb_uri_is_hidden</a>                    (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
 
56
<span class="returnvalue">gboolean</span>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-could-be-podcast" title="rb_uri_could_be_podcast ()">rb_uri_could_be_podcast</a>             (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
 
57
                                                         <em class="parameter"><code><span class="type">gboolean</span> *is_opml</code></em>);
58
58
<span class="returnvalue">char</span> *              <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-make-hidden" title="rb_uri_make_hidden ()">rb_uri_make_hidden</a>                  (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
59
59
<span class="returnvalue">void</span>                <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-handle-recursively" title="rb_uri_handle_recursively ()">rb_uri_handle_recursively</a>           (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
60
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancel</code></em>,
 
60
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancel</code></em>,
61
61
                                                         <em class="parameter"><code><a class="link" href="rhythmbox-rb-file-helpers.html#RBUriRecurseFunc" title="RBUriRecurseFunc ()"><span class="type">RBUriRecurseFunc</span></a> func</code></em>,
62
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
 
62
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
63
63
<span class="returnvalue">void</span>                <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-handle-recursively-async" title="rb_uri_handle_recursively_async ()">rb_uri_handle_recursively_async</a>     (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
64
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancel</code></em>,
 
64
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancel</code></em>,
65
65
                                                         <em class="parameter"><code><a class="link" href="rhythmbox-rb-file-helpers.html#RBUriRecurseFunc" title="RBUriRecurseFunc ()"><span class="type">RBUriRecurseFunc</span></a> func</code></em>,
66
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
67
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> data_destroy</code></em>);
68
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-mkstemp" title="rb_uri_mkstemp ()">rb_uri_mkstemp</a>                      (<em class="parameter"><code>const <span class="type">char</span> *prefix</code></em>,
 
66
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
 
67
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> data_destroy</code></em>);
 
68
<span class="returnvalue">gboolean</span>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-mkstemp" title="rb_uri_mkstemp ()">rb_uri_mkstemp</a>                      (<em class="parameter"><code>const <span class="type">char</span> *prefix</code></em>,
69
69
                                                         <em class="parameter"><code><span class="type">char</span> **uri_ret</code></em>,
70
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GOutputStream.html"><span class="type">GOutputStream</span></a> **stream</code></em>,
71
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
70
                                                         <em class="parameter"><code><span class="type">GOutputStream</span> **stream</code></em>,
 
71
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
72
72
<span class="returnvalue">char</span> *              <a class="link" href="rhythmbox-rb-file-helpers.html#rb-canonicalise-uri" title="rb_canonicalise_uri ()">rb_canonicalise_uri</a>                 (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
73
73
<span class="returnvalue">char</span> *              <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-append-path" title="rb_uri_append_path ()">rb_uri_append_path</a>                  (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
74
74
                                                         <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);
76
76
                                                         <em class="parameter"><code>const <span class="type">char</span> *fragment</code></em>);
77
77
<span class="returnvalue">char</span> *              <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-get-dir-name" title="rb_uri_get_dir_name ()">rb_uri_get_dir_name</a>                 (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
78
78
<span class="returnvalue">char</span> *              <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-get-short-path-name" title="rb_uri_get_short_path_name ()">rb_uri_get_short_path_name</a>          (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
79
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-check-dir-has-space" title="rb_check_dir_has_space ()">rb_check_dir_has_space</a>              (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> *dir</code></em>,
 
79
<span class="returnvalue">gboolean</span>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-check-dir-has-space" title="rb_check_dir_has_space ()">rb_check_dir_has_space</a>              (<em class="parameter"><code><span class="type">GFile</span> *dir</code></em>,
80
80
                                                         <em class="parameter"><code><span class="type">guint64</span> bytes_needed</code></em>);
81
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-check-dir-has-space-uri" title="rb_check_dir_has_space_uri ()">rb_check_dir_has_space_uri</a>          (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
 
81
<span class="returnvalue">gboolean</span>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-check-dir-has-space-uri" title="rb_check_dir_has_space_uri ()">rb_check_dir_has_space_uri</a>          (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
82
82
                                                         <em class="parameter"><code><span class="type">guint64</span> bytes_needed</code></em>);
83
83
<span class="returnvalue">char</span> *              <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-get-mount-point" title="rb_uri_get_mount_point ()">rb_uri_get_mount_point</a>              (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
84
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-create-parent-dirs" title="rb_uri_create_parent_dirs ()">rb_uri_create_parent_dirs</a>           (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
85
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
86
 
<a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="returnvalue">GFile</span></a> *             <a class="link" href="rhythmbox-rb-file-helpers.html#rb-file-find-extant-parent" title="rb_file_find_extant_parent ()">rb_file_find_extant_parent</a>          (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> *file</code></em>);
 
84
<span class="returnvalue">gboolean</span>            <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-create-parent-dirs" title="rb_uri_create_parent_dirs ()">rb_uri_create_parent_dirs</a>           (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
 
85
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
86
<span class="returnvalue">GFile</span> *             <a class="link" href="rhythmbox-rb-file-helpers.html#rb-file-find-extant-parent" title="rb_file_find_extant_parent ()">rb_file_find_extant_parent</a>          (<em class="parameter"><code><span class="type">GFile</span> *file</code></em>);
87
87
<span class="returnvalue">char</span> *              <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-get-filesystem-type" title="rb_uri_get_filesystem_type ()">rb_uri_get_filesystem_type</a>          (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
88
88
                                                         <em class="parameter"><code><span class="type">char</span> **mount_point</code></em>);
89
89
<span class="returnvalue">void</span>                <a class="link" href="rhythmbox-rb-file-helpers.html#rb-sanitize-path-for-msdos-filesystem" title="rb_sanitize_path_for_msdos_filesystem ()">rb_sanitize_path_for_msdos_filesystem</a>
90
90
                                                        (<em class="parameter"><code><span class="type">char</span> *path</code></em>);
91
91
<span class="returnvalue">char</span> *              <a class="link" href="rhythmbox-rb-file-helpers.html#rb-sanitize-uri-for-filesystem" title="rb_sanitize_uri_for_filesystem ()">rb_sanitize_uri_for_filesystem</a>      (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
92
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (<a class="link" href="rhythmbox-rb-file-helpers.html#RBUriRecurseFunc" title="RBUriRecurseFunc ()">*RBUriRecurseFunc</a>)                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> *file</code></em>,
93
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> dir</code></em>,
94
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
 
92
<span class="returnvalue">gboolean</span>            (<a class="link" href="rhythmbox-rb-file-helpers.html#RBUriRecurseFunc" title="RBUriRecurseFunc ()">*RBUriRecurseFunc</a>)                 (<em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
 
93
                                                         <em class="parameter"><code><span class="type">gboolean</span> dir</code></em>,
 
94
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
95
95
</pre>
96
96
</div>
97
97
<div class="refsect1">
226
226
<hr>
227
227
<div class="refsect2">
228
228
<a name="rb-file-helpers-init"></a><h3>rb_file_helpers_init ()</h3>
229
 
<pre class="programlisting"><span class="returnvalue">void</span>                rb_file_helpers_init                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> uninstalled</code></em>);</pre>
 
229
<pre class="programlisting"><span class="returnvalue">void</span>                rb_file_helpers_init                (<em class="parameter"><code><span class="type">gboolean</span> uninstalled</code></em>);</pre>
230
230
<p>
231
231
Sets up file search paths for <em class="parameter"><code>rb_file</code></em>.  Must be called on startup.
232
232
</p>
234
234
<col align="left" valign="top">
235
235
<tbody><tr>
236
236
<td><p><span class="term"><em class="parameter"><code>uninstalled</code></em> :</span></p></td>
237
 
<td>if <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, search in source and build directories
 
237
<td>if <code class="literal">TRUE</code>, search in source and build directories
238
238
as well as installed locations</td>
239
239
</tr></tbody>
240
240
</table></div>
252
252
<div class="refsect2">
253
253
<a name="rb-uri-resolve-symlink"></a><h3>rb_uri_resolve_symlink ()</h3>
254
254
<pre class="programlisting"><span class="returnvalue">char</span> *              rb_uri_resolve_symlink              (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
255
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
255
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
256
256
<p>
257
257
Attempts to resolve symlinks in <em class="parameter"><code>uri</code></em> and return a canonical URI for the file
258
258
it identifies.
278
278
<hr>
279
279
<div class="refsect2">
280
280
<a name="rb-uri-is-directory"></a><h3>rb_uri_is_directory ()</h3>
281
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_uri_is_directory                 (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
 
281
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_uri_is_directory                 (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
282
282
<p>
283
283
Checks if <em class="parameter"><code>uri</code></em> identifies a directory.
284
284
</p>
292
292
<tr>
293
293
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
294
294
<td>
295
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em> is a directory</td>
 
295
<code class="literal">TRUE</code> if <em class="parameter"><code>uri</code></em> is a directory</td>
296
296
</tr>
297
297
</tbody>
298
298
</table></div>
300
300
<hr>
301
301
<div class="refsect2">
302
302
<a name="rb-uri-exists"></a><h3>rb_uri_exists ()</h3>
303
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_uri_exists                       (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
 
303
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_uri_exists                       (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
304
304
<p>
305
305
Checks if a URI identifies a resource that exists
306
306
</p>
314
314
<tr>
315
315
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
316
316
<td>
317
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em> exists</td>
 
317
<code class="literal">TRUE</code> if <em class="parameter"><code>uri</code></em> exists</td>
318
318
</tr>
319
319
</tbody>
320
320
</table></div>
322
322
<hr>
323
323
<div class="refsect2">
324
324
<a name="rb-uri-is-readable"></a><h3>rb_uri_is_readable ()</h3>
325
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_uri_is_readable                  (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
 
325
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_uri_is_readable                  (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
326
326
<p>
327
327
Checks if the user can read the resource identified by <em class="parameter"><code>uri</code></em>
328
328
</p>
336
336
<tr>
337
337
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
338
338
<td>
339
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em> is readable</td>
 
339
<code class="literal">TRUE</code> if <em class="parameter"><code>uri</code></em> is readable</td>
340
340
</tr>
341
341
</tbody>
342
342
</table></div>
344
344
<hr>
345
345
<div class="refsect2">
346
346
<a name="rb-uri-is-writable"></a><h3>rb_uri_is_writable ()</h3>
347
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_uri_is_writable                  (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
 
347
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_uri_is_writable                  (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
348
348
<p>
349
349
Checks if the user can write to the resource identified by <em class="parameter"><code>uri</code></em>
350
350
</p>
358
358
<tr>
359
359
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
360
360
<td>
361
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em> is writable</td>
 
361
<code class="literal">TRUE</code> if <em class="parameter"><code>uri</code></em> is writable</td>
362
362
</tr>
363
363
</tbody>
364
364
</table></div>
366
366
<hr>
367
367
<div class="refsect2">
368
368
<a name="rb-uri-is-local"></a><h3>rb_uri_is_local ()</h3>
369
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_uri_is_local                     (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
 
369
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_uri_is_local                     (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
370
370
<p>
371
371
Checks if <em class="parameter"><code>uri</code></em> identifies a local resource.  Currently this just
372
372
checks that it uses the 'file' URI scheme.
381
381
<tr>
382
382
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
383
383
<td>
384
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em> is local</td>
 
384
<code class="literal">TRUE</code> if <em class="parameter"><code>uri</code></em> is local</td>
385
385
</tr>
386
386
</tbody>
387
387
</table></div>
389
389
<hr>
390
390
<div class="refsect2">
391
391
<a name="rb-uri-is-hidden"></a><h3>rb_uri_is_hidden ()</h3>
392
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_uri_is_hidden                    (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
 
392
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_uri_is_hidden                    (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
393
393
<p>
394
394
Checks if <em class="parameter"><code>uri</code></em> is hidden, according to the Unix filename convention.
395
395
If the filename component of <em class="parameter"><code>uri</code></em> begins with a dot, the file is considered
405
405
<tr>
406
406
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
407
407
<td>
408
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em> is hidden</td>
 
408
<code class="literal">TRUE</code> if <em class="parameter"><code>uri</code></em> is hidden</td>
409
409
</tr>
410
410
</tbody>
411
411
</table></div>
413
413
<hr>
414
414
<div class="refsect2">
415
415
<a name="rb-uri-could-be-podcast"></a><h3>rb_uri_could_be_podcast ()</h3>
416
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_uri_could_be_podcast             (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
417
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *is_opml</code></em>);</pre>
 
416
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_uri_could_be_podcast             (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
 
417
                                                         <em class="parameter"><code><span class="type">gboolean</span> *is_opml</code></em>);</pre>
418
418
<p>
419
419
Checks if <em class="parameter"><code>uri</code></em> identifies a resource that is probably a podcast
420
420
(RSS or Atom feed).  This does not perform any IO, it just guesses
434
434
<tr>
435
435
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
436
436
<td>
437
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em> may be a podcast</td>
 
437
<code class="literal">TRUE</code> if <em class="parameter"><code>uri</code></em> may be a podcast</td>
438
438
</tr>
439
439
</tbody>
440
440
</table></div>
466
466
<div class="refsect2">
467
467
<a name="rb-uri-handle-recursively"></a><h3>rb_uri_handle_recursively ()</h3>
468
468
<pre class="programlisting"><span class="returnvalue">void</span>                rb_uri_handle_recursively           (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
469
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancel</code></em>,
 
469
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancel</code></em>,
470
470
                                                         <em class="parameter"><code><a class="link" href="rhythmbox-rb-file-helpers.html#RBUriRecurseFunc" title="RBUriRecurseFunc ()"><span class="type">RBUriRecurseFunc</span></a> func</code></em>,
471
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
 
471
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
472
472
<p>
473
473
Calls <em class="parameter"><code>func</code></em> for each file found under the directory identified by <em class="parameter"><code>uri</code></em>.
474
474
If <em class="parameter"><code>uri</code></em> identifies a file, calls <em class="parameter"><code>func</code></em> for that instead.
482
482
</tr>
483
483
<tr>
484
484
<td><p><span class="term"><em class="parameter"><code>cancel</code></em> :</span></p></td>
485
 
<td>an optional <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> to allow cancellation</td>
 
485
<td>an optional <span class="type">GCancellable</span> to allow cancellation</td>
486
486
</tr>
487
487
<tr>
488
488
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
500
500
<div class="refsect2">
501
501
<a name="rb-uri-handle-recursively-async"></a><h3>rb_uri_handle_recursively_async ()</h3>
502
502
<pre class="programlisting"><span class="returnvalue">void</span>                rb_uri_handle_recursively_async     (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
503
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancel</code></em>,
 
503
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancel</code></em>,
504
504
                                                         <em class="parameter"><code><a class="link" href="rhythmbox-rb-file-helpers.html#RBUriRecurseFunc" title="RBUriRecurseFunc ()"><span class="type">RBUriRecurseFunc</span></a> func</code></em>,
505
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
506
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> data_destroy</code></em>);</pre>
 
505
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
 
506
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> data_destroy</code></em>);</pre>
507
507
<p>
508
508
Calls <em class="parameter"><code>func</code></em> for each file found under the directory identified
509
509
by <em class="parameter"><code>uri</code></em>, or if <em class="parameter"><code>uri</code></em> identifies a file, calls it once
526
526
</tr>
527
527
<tr>
528
528
<td><p><span class="term"><em class="parameter"><code>cancel</code></em> :</span></p></td>
529
 
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> to allow cancellation</td>
 
529
<td>a <span class="type">GCancellable</span> to allow cancellation</td>
530
530
</tr>
531
531
<tr>
532
532
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
547
547
<hr>
548
548
<div class="refsect2">
549
549
<a name="rb-uri-mkstemp"></a><h3>rb_uri_mkstemp ()</h3>
550
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_uri_mkstemp                      (<em class="parameter"><code>const <span class="type">char</span> *prefix</code></em>,
 
550
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_uri_mkstemp                      (<em class="parameter"><code>const <span class="type">char</span> *prefix</code></em>,
551
551
                                                         <em class="parameter"><code><span class="type">char</span> **uri_ret</code></em>,
552
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GOutputStream.html"><span class="type">GOutputStream</span></a> **stream</code></em>,
553
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
552
                                                         <em class="parameter"><code><span class="type">GOutputStream</span> **stream</code></em>,
 
553
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
554
554
<p>
555
555
Creates a temporary file whose URI begins with <em class="parameter"><code>prefix</code></em>, returning
556
556
the file URI and an output stream for writing to it.
577
577
<tr>
578
578
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
579
579
<td>
580
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful</td>
 
580
<code class="literal">TRUE</code> if successful</td>
581
581
</tr>
582
582
</tbody>
583
583
</table></div>
705
705
<hr>
706
706
<div class="refsect2">
707
707
<a name="rb-check-dir-has-space"></a><h3>rb_check_dir_has_space ()</h3>
708
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_check_dir_has_space              (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> *dir</code></em>,
 
708
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_check_dir_has_space              (<em class="parameter"><code><span class="type">GFile</span> *dir</code></em>,
709
709
                                                         <em class="parameter"><code><span class="type">guint64</span> bytes_needed</code></em>);</pre>
710
710
<p>
711
711
Checks that the filesystem holding <em class="parameter"><code>file</code></em> has at least <em class="parameter"><code>bytes_needed</code></em>
716
716
<tbody>
717
717
<tr>
718
718
<td><p><span class="term"><em class="parameter"><code>dir</code></em> :</span></p></td>
719
 
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> to check</td>
 
719
<td>a <span class="type">GFile</span> to check</td>
720
720
</tr>
721
721
<tr>
722
722
<td><p><span class="term"><em class="parameter"><code>bytes_needed</code></em> :</span></p></td>
725
725
<tr>
726
726
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
727
727
<td>
728
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if enough space is available.</td>
 
728
<code class="literal">TRUE</code> if enough space is available.</td>
729
729
</tr>
730
730
</tbody>
731
731
</table></div>
733
733
<hr>
734
734
<div class="refsect2">
735
735
<a name="rb-check-dir-has-space-uri"></a><h3>rb_check_dir_has_space_uri ()</h3>
736
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_check_dir_has_space_uri          (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
 
736
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_check_dir_has_space_uri          (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
737
737
                                                         <em class="parameter"><code><span class="type">guint64</span> bytes_needed</code></em>);</pre>
738
738
<p>
739
739
Checks that the filesystem holding <em class="parameter"><code>uri</code></em> has at least <em class="parameter"><code>bytes_needed</code></em>
753
753
<tr>
754
754
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
755
755
<td>
756
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if enough space is available.</td>
 
756
<code class="literal">TRUE</code> if enough space is available.</td>
757
757
</tr>
758
758
</tbody>
759
759
</table></div>
785
785
<hr>
786
786
<div class="refsect2">
787
787
<a name="rb-uri-create-parent-dirs"></a><h3>rb_uri_create_parent_dirs ()</h3>
788
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_uri_create_parent_dirs           (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
789
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
788
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_uri_create_parent_dirs           (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
 
789
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
790
790
<p>
791
791
Ensures that all parent directories of <em class="parameter"><code>uri</code></em> exist so that
792
792
<em class="parameter"><code>uri</code></em> itself can be created directly.
805
805
<tr>
806
806
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
807
807
<td>
808
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful</td>
 
808
<code class="literal">TRUE</code> if successful</td>
809
809
</tr>
810
810
</tbody>
811
811
</table></div>
813
813
<hr>
814
814
<div class="refsect2">
815
815
<a name="rb-file-find-extant-parent"></a><h3>rb_file_find_extant_parent ()</h3>
816
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="returnvalue">GFile</span></a> *             rb_file_find_extant_parent          (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> *file</code></em>);</pre>
 
816
<pre class="programlisting"><span class="returnvalue">GFile</span> *             rb_file_find_extant_parent          (<em class="parameter"><code><span class="type">GFile</span> *file</code></em>);</pre>
817
817
<p>
818
 
Walks up the filesystem hierarchy to find a <a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> representing
 
818
Walks up the filesystem hierarchy to find a <span class="type">GFile</span> representing
819
819
the nearest extant ancestor of the specified file, which may be
820
820
the file itself if it exists.
821
821
</p>
824
824
<tbody>
825
825
<tr>
826
826
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
827
 
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> to find an extant ancestor of</td>
 
827
<td>a <span class="type">GFile</span> to find an extant ancestor of</td>
828
828
</tr>
829
829
<tr>
830
830
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
831
831
<td>
832
 
<a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> for the nearest extant ancestor. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
 
832
<span class="type">GFile</span> for the nearest extant ancestor. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
833
833
</td>
834
834
</tr>
835
835
</tbody>
904
904
<hr>
905
905
<div class="refsect2">
906
906
<a name="RBUriRecurseFunc"></a><h3>RBUriRecurseFunc ()</h3>
907
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (*RBUriRecurseFunc)                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> *file</code></em>,
908
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> dir</code></em>,
909
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 
907
<pre class="programlisting"><span class="returnvalue">gboolean</span>            (*RBUriRecurseFunc)                 (<em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
 
908
                                                         <em class="parameter"><code><span class="type">gboolean</span> dir</code></em>,
 
909
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
910
910
<p>
911
911
</p>
912
912
</div>
914
914
</div>
915
915
<div class="footer">
916
916
<hr>
917
 
          Generated by GTK-Doc V1.18.1</div>
 
917
          Generated by GTK-Doc V1.18</div>
918
918
</body>
919
919
</html>
 
 
b'\\ No newline at end of file'