File: gnomevfs-functions.xml

package info (click to toggle)
gnome-python 2.28.1%2Bdfsg-1.1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 3,288 kB
  • ctags: 1,032
  • sloc: sh: 10,219; ansic: 7,997; xml: 2,464; python: 1,886; makefile: 394
file content (667 lines) | stat: -rw-r--r-- 35,360 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="gnomevfs-functions">
  <refnamediv>
    <refname>gnomevfs Functions</refname>
    <refpurpose>Additional functions which are not part of a class.</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>
    <!-- I apologize for the whitespace here.  It makes fugly HTML otherwise -->
    <programlisting><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--create">gnomevfs.create</link></methodname>
	<methodparam><parameter role="keyword">uri</parameter></methodparam>
	<methodparam><parameter role="keyword">open_mode</parameter><initializer>gnomevfs.OPEN_NONE</initializer></methodparam>
	<methodparam><parameter role="keyword">exclusive</parameter><initializer>False</initializer></methodparam>
	<methodparam><parameter role="keyword">perm</parameter><initializer>0666</initializer></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--get_file_info">gnomevfs.get_file_info</link></methodname>
	<methodparam><parameter role="keyword">uri</parameter></methodparam>
	<methodparam><parameter role="keyword">options</parameter><initializer>gnomevfs.FILE_INFO_DEFAULT</initializer></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--set_file_info">gnomevfs.set_file_info</link></methodname>
	<methodparam><parameter role="keyword">uri</parameter></methodparam>
	<methodparam><parameter role="keyword">info</parameter></methodparam>
	<methodparam><parameter role="keyword">mask</parameter><initializer>gnomevfs.SET_FILE_INFO_NONE</initializer></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--truncate">gnomevfs.truncate</link></methodname>
	<methodparam><parameter role="keyword">uri</parameter></methodparam>
	<methodparam><parameter role="keyword">length</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--make_directory">gnomevfs.make_directory</link></methodname>
	<methodparam><parameter role="keyword">uri</parameter></methodparam>
	<methodparam><parameter role="keyword">perm</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--remove_directory">gnomevfs.remove_directory</link></methodname>
	<methodparam><parameter role="keyword">uri</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--unlink">gnomevfs.unlink</link></methodname>
	<methodparam><parameter role="keyword">uri</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--exists">gnomevfs.exists</link></methodname>
	<methodparam><parameter role="keyword">uri</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--format_file_size_for_display">gnomevfs.format_file_size_for_display</link></methodname>
	<methodparam><parameter>size</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--get_mime_type">gnomevfs.get_mime_type</link></methodname>
	<methodparam><parameter>uri</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--get_mime_type_for_data">gnomevfs.get_mime_type_for_data</link></methodname>
	<methodparam><parameter>data</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--mime_get_icon">gnomevfs.mime_get_icon</link></methodname>
	<methodparam><parameter>mime_type</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_set_icon</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--mime_get_description">gnomevfs.mime_get_description</link></methodname>
	<methodparam><parameter>mime_type</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_set_description</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--mime_can_be_executable">gnomevfs.mime_can_be_executable</link></methodname>
	<methodparam><parameter>mime_type</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_set_can_be_executable</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--monitor_add">gnomevfs.monitor_add</link></methodname>
	<methodparam><parameter>text_uri</parameter></methodparam>
	<methodparam><parameter>monitor_type</parameter></methodparam>
	<methodparam><parameter>callback</parameter></methodparam>
	<methodparam><parameter>user_data</parameter><initializer>None</initializer></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--monitor_cancel">gnomevfs.monitor_cancel</link></methodname>
	<methodparam><parameter>id</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--read_entire_file">gnomevfs.read_entire_file</link></methodname>
	<methodparam><parameter>text_uri</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--mime_get_default_application">gnomevfs.mime_get_default_application</link></methodname>
	<methodparam><parameter>mime_type</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.xfer_uri</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.xfer_uri_list</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.xfer_delete_list</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_get_default_action_type</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_get_default_action</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_get_default_component</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_get_short_list_components</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_get_short_list_applications</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_get_all_applications</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_get_all_components</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_set_default_action_type</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_set_default_application</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_set_default_component</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_set_short_list_applications</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_set_short_list_components</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_add_application_to_short_list</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_remove_application_from_short_list</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_add_component_to_short_list</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_remove_component_from_short_list</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_add_extension</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_remove_extension</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_extend_all_applications</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_remove_from_all_applications</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.mime_application_new_from_id</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.connect_to_server</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.escape_string</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.escape_path_string</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.escape_host_and_path_string</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.escape_slashes</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.escape_set</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.unescape_string</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.make_uri_canonical</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.make_path_name_canonical</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.unescape_string_for_display</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.get_local_path_from_uri</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.get_uri_from_local_path</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.is_executable_command_string</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.get_volume_free_space</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.icon_path_from_filename</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.open_fd</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.is_primary_thread</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.format_uri_for_display</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.make_uri_from_input</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.make_uri_from_input_with_dirs</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.make_uri_canonical_strip_fragment</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.uris_match</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.get_uri_scheme</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.make_uri_from_shell_arg</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.url_show</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.resolve</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.dns_sd_browse_sync</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.dns_sd_resolve_sync</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.dns_sd_list_browse_domains_sync</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gnomevfs--">gnomevfs.get_default_browse_domains</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
    </programlisting>
  </refsect1>

  <refsect1>
    <title>Description</title>
    <para>These functions are part of the gnomevfs module but are not associated with a specific class.</para>
  </refsect1>

  <refsect1>
    <title>Functions</title>

    <refsect2 id="function-gnomevfs--create">
      <title>gnomevfs.create</title>
      <programlisting>
        <methodsynopsis language="python">
	  <methodname>gnomevfs.create</methodname>
	  <methodparam><parameter role="keyword">uri</parameter></methodparam>
	  <methodparam><parameter role="keyword">open_mode</parameter><initializer>gnomevfs.OPEN_NONE</initializer></methodparam>
	  <methodparam><parameter role="keyword">exclusive</parameter><initializer>False</initializer></methodparam>
	  <methodparam><parameter role="keyword">perm</parameter><initializer>0666</initializer></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter role="keyword">uri</parameter>:</term>
	  <listitem><simpara>The URI to create.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">open_mode</parameter>:</term>
	  <listitem><simpara>Mode to leave the file in after creation (or gnomevfs.OPEN_MODE_NONE to leave the file closed).</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">exclusive</parameter>:</term>
	  <listitem><simpara>Whether the file should be created in "exclusive" mode. i.e. if this flag is nonzero, The operation will fail if a file with the same name already exists.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">perm</parameter>:</term>
	  <listitem><simpara>Or'd set of <link linkend="gnomevfs-constants-file-permissions">file permissions flags</link></simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>:</term>
	  <listitem><simpara>A <link linkend="class-gnomevfs-handle">gnomevfs.Handle</link>.</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Create and open <parameter role="keyword">uri</parameter> according to <parameter role="keyword">open_mode</parameter>.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--get_file_info">
      <title>gnomevfs.get_file_info</title>
      <programlisting>
        <methodsynopsis language="python">
	  <methodname>gnomevfs.get_file_info</methodname>
	  <methodparam><parameter role="keyword">uri</parameter></methodparam>
	  <methodparam><parameter role="keyword">options</parameter><initializer>gnomevfs.FILE_INFO_DEFAULT</initializer></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter role="keyword">uri</parameter>:</term>
	  <listitem><simpara>The URI to retrieve information for.</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><parameter role="keyword">options</parameter>:</term>
	  <listitem><simpara>Or'd set of <link linkend="gnomevfs-constants-fileinfo-option">file info options</link>.</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><emphasis>Returns</emphasis>:</term>
	  <listitem><simpara>A <link linkend="class-gnomevfs-fileinfo">gnomevfs.FileInfo</link></simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Retrieve information about <parameter role="keyword">uri</parameter>.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--set_file_info">
      <title>gnomevfs.set_file_info</title>
      <programlisting>
        <methodsynopsis language="python">
          <methodname>gnomevfs.set_file_info</methodname>
	  <methodparam><parameter role="keyword">uri</parameter></methodparam>
	  <methodparam><parameter role="keyword">info</parameter></methodparam>
	  <methodparam><parameter role="keyword">mask</parameter><initializer>gnomevfs.SET_FILE_INFO_NONE</initializer></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter role="keyword">uri</parameter>:</term>
	  <listitem><simpara>The URI to set information on.</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><parameter role="keyword">info</parameter>:</term>
	  <listitem><simpara><link linkend="class-gnomevfs-fileinfo">gnomevfs.FileInfo</link> with the information to set.</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><parameter role="keyword">mask</parameter>:</term>
	  <listitem><simpara>Or'd set of <link linkend="gnomevfs-constants-fileinfo-setmask">file info set flags</link>.</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Set file information for <parameter role="keyword">uri</parameter>.  Only the information for which the corresponding bit in <parameter role="keyword">mask</parameter> is set is actually modified.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--truncate">
      <title>gnomevfs.truncate</title>
      <programlisting>
        <methodsynopsis language="python">
          <methodname>gnomevfs.truncate</methodname>
	  <methodparam><parameter role="keyword">uri</parameter></methodparam>
	  <methodparam><parameter role="keyword">length</parameter></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter role="keyword">uri</parameter>:</term>
	  <listitem><simpara>The URI of the file to truncate.</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><parameter role="keyword">length</parameter>:</term>
	  <listitem><simpara>The length to truncate to.</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Truncate a file to a specific length.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--make_directory">
      <title>gnomevfs.make_directory</title>
      <programlisting>
        <methodsynopsis language="python">
	  <methodname>gnomevfs.make_directory</methodname>
	  <methodparam><parameter role="keyword">uri</parameter></methodparam>
	  <methodparam><parameter role="keyword">perm</parameter></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter role="keyword">uri</parameter>:</term>
	  <listitem><simpara>The URI of the directory to create.</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><parameter role="keyword">perm</parameter>:</term>
	  <listitem><simpara>Or'd set of <link linkend="gnomevfs-constants-file-permissions">file permissions flags</link>.</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Create a directory with the given name and permissions.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--remove_directory">
      <title>gnomevfs.remove_directory</title>
      <programlisting>
        <methodsynopsis language="python">
	  <methodname>gnomevfs.remove_directory</methodname>
	  <methodparam><parameter role="keyword">uri</parameter></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter role="keyword">uri</parameter>:</term>
	  <listitem><simpara>The URI of the directory to remove.</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Remove a directory.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--unlink">
      <title>gnomevfs.unlink</title>
      <programlisting>
        <methodsynopsis language="python">
	  <methodname>gnomevfs.unlink</methodname>
	  <methodparam><parameter role="keyword">uri</parameter></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter role="keyword">uri</parameter>:</term>
	  <listitem><simpara>The URI of the file to unlink</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Unlink (delete) a URI.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--exists">
      <title>gnomevfs.exists</title>
      <programlisting>
        <methodsynopsis language="python">
	  <methodname>gnomevfs.exists</methodname>
	  <methodparam><parameter role="keyword">uri</parameter></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter role="keyword">uri</parameter>:</term>
	  <listitem><simpara>The URI to check.</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><emphasis>Returns</emphasis>:</term>
	  <listitem><simpara>True if the URI exists.</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Check if a given URI exists.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--format_file_size_for_display">
      <title>gnomevfs.format_file_size_for_display</title>
      <programlisting>
        <methodsynopsis language="python">
	  <methodname>gnomevfs.format_file_size_for_display</methodname>
	  <methodparam><parameter>size</parameter></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter>size</parameter>:</term>
	  <listitem><simpara>The size of the file in bytes</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><emphasis>Returns</emphasis>:</term>
	  <listitem><simpara>A string with the printable size</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Formats <parameter>size</parameter> in a way that is easy for the user to read.  Gives the size in bytes, kilobytes, megabytes or gigabytes, choosing whatever is appropriate.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--get_mime_type">
      <title>gnomevfs.get_mime_type</title>
      <programlisting>
        <methodsynopsis language="python">
	  <methodname>gnomevfs.get_mime_type</methodname>
	  <methodparam><parameter>uri</parameter></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter>uri</parameter>:</term>
	  <listitem><simpara>The URI to retrieve the mime type for.</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><emphasis>Returns</emphasis>:</term>
	  <listitem><simpara>A string containing the mime type.</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Determine the mime type of <parameter>uri</parameter>.  The mime type is determined in the same way as by <link linkend="function-gnomevfs--get_file_info">gnomevfs.get_file_info</link>.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--get_mime_type_for_data">
      <title>gnomevfs.get_mime_type_for_data</title>
      <programlisting>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter>data</parameter>:</term>
	  <listitem><simpara>A string containing the data.</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><emphasis>Returns</emphasis>:</term>
	  <listitem><simpara>A string containing the mime type.</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Tries to guess the mime type of the data in <parameter>data</parameter> using magic patterns.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--mime_get_icon">
      <title>gnomevfs.mime_get_icon</title>
      <programlisting>
        <methodsynopsis language="python">
	  <methodname>gnomevfs.mime_get_icon</methodname>
	  <methodparam><parameter>mime_type</parameter></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter>mime_type</parameter>:</term>
	  <listitem><simpara>A string with the mime type.</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><emphasis>Returns</emphasis>:</term>
	  <listitem><simpara>A string with an icon name.</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Query the MIME database for an icon representing <parameter>mime_type</parameter>.  It usually returns a filename without path information, e.g. "i-chardev.png", and sometimes does not have an extension, e.g. "i-regular" if the icon is supposed to be image type agnostic between icon themes. Icons are generic and not theme specific. These will not necessarily match with the icons a user sees in Nautilus, you have been warned.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--mime_get_description">
      <title>gnomevfs.mime_get_description</title>
      <programlisting>
        <methodsynopsis language="python">
	  <methodname>gnomevfs.mime_get_description</methodname>
	  <methodparam><parameter>mime_type</parameter></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter>mime_type</parameter>:</term>
	  <listitem><simpara>The mime type to query.</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><emphasis>Returns</emphasis>:</term>
	  <listitem><simpara>A description of the mime type.</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Query the MIME database for a description of <parameter>mime_type</parameter>.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--mime_can_be_executable">
      <title>gnomevfs.mime_can_be_executable</title>
      <programlisting>
        <methodsynopsis language="python">
	  <methodname>gnomevfs.mime_can_be_executable</methodname>
	  <methodparam><parameter>mime_type</parameter></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter>mime_type</parameter>:</term>
	  <listitem><simpara>The mime type to query.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>:</term>
	  <listitem><simpara>True if files of <parameter>mime_type</parameter> can be executable, False otherwise.</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Check whether files of <parameter>mime_type</parameter> might conceivably be executable. Default for known types is False. Default for unknown types is True.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--monitor_add">
      <title>gnomevfs.monitor_add</title>
      <programlisting>
        <methodsynopsis language="python">
	  <methodname>gnomevfs.monitor_add</methodname>
	  <methodparam><parameter>text_uri</parameter></methodparam>
	  <methodparam><parameter>monitor_type</parameter></methodparam>
	  <methodparam><parameter>callback</parameter></methodparam>
	  <methodparam><parameter>extra</parameter><initializer>None</initializer></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter>text_uri</parameter>:</term>
	  <listitem><simpara>String representing the URI to monitor.</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><parameter>monitor_type</parameter>:</term>
	  <listitem><simpara>A <link linkend="gnomevfs-constants-monitortype">monitor type</link> signifying the type of the URI.</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><parameter>callback</parameter>:</term>
	  <listitem><simpara>Function to call when the monitor is tripped.</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><parameter>user_data</parameter>:</term>
	  <listitem><simpara>Data to pass to <parameter>callback</parameter></simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>:</term>
	  <listitem><simpara>An identifier representing this monitor.</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Watch the file or directory at <parameter>text_uri</parameter> for changes (or the creation/deletion of the file) and call <parameter>callback</parameter> when there is a change. If a directory monitor is added, <parameter>callback</parameter> is notified when any file in the directory changes.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--monitor_cancel">
      <title>gnomevfs.monitor_cancel</title>
      <programlisting>
        <methodsynopsis language="python">
	  <methodname>gnomevfs.monitor_cancel</methodname>
	  <methodparam><parameter>id</parameter></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter>id</parameter>:</term>
	  <listitem><simpara>Identifier which was given by <link linkend="function-gnomevfs--monitor_add">monitor_add</link></simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Cancel the monitor pointed to by <parameter>id</parameter></para>
    </refsect2>

    <refsect2 id="function-gnomevfs--read_entire_file">
      <title>gnomevfs.read_entire_file</title>
      <programlisting>
        <methodsynopsis language="python">
	  <methodname>gnomevfs.read_entire_file</methodname>
	  <methodparam><parameter>text_uri</parameter></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter>text_uri</parameter>:</term>
	  <listitem><simpara>String containing the URI of the file to read.</simpara></listitem>
        </varlistentry>
        <varlistentry>
	  <term><emphasis>Returns</emphasis>:</term>
	  <listitem><simpara>String containing the data in the file.</simpara></listitem>
        </varlistentry>
      </variablelist>
      <para>Reads an entire file into memory for convenience. Beware of accidentally loading large files into memory with this function.</para>
    </refsect2>

    <refsect2 id="function-gnomevfs--mime_get_default_application">
      <title>gnomevfs.mime_get_default_application</title>
      <programlisting>
        <methodsynopsis language="python">
	  <methodname>gnomevfs.mime_get_default_application</methodname>
	  <methodparam><parameter>mime_type</parameter></methodparam>
	</methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
	  <term><parameter>mime_type</parameter>:</term>
	  <listitem><simpara>Mime type to query.</simpara></listitem>
	</varlistentry>
        <varlistentry>
	  <term><emphasis>Returns</emphasis>:</term>
	  <listitem><simpara>Information about the application configured as the default handler for <parameter>mime_type</parameter>.</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>Query the MIME database for the default Bonobo component to be activated to view files of MIME type <parameter>mime_type</parameter></para>
    </refsect2>
  </refsect1>
</refentry>