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
|
<?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="class-giodrive">
<refnamediv>
<refname>gio.Drive</refname>
<refpurpose>Virtual File System drive management.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gio.Drive</classname></ooclass>
<ooclass><classname><link linkend="class-gobjectginterface">gobject.GInterface</link></classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-giodrive--can-eject">can_eject</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giodrive--can-poll-for-media">can_poll_for_media</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giodrive--eject">eject</link></methodname>
<methodparam><parameter role="keyword">callback</parameter></methodparam>
<methodparam><parameter role="keyword">flags</parameter><initializer><literal>gio.MOUNT_UNMOUNT_NONE</literal></initializer></methodparam>
<methodparam><parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer></methodparam>
<methodparam><parameter role="keyword">user_data</parameter><initializer><literal>None</literal></initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giodrive--eject-finish">eject_finish</link></methodname>
<methodparam><parameter role="keyword">result</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giodrive--enumerate-identifiers">enumerate_identifiers</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giodrive--get-icon">get_icon</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giodrive--get-identifier">get_identifier</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giodrive--get-name">get_name</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giodrive--get-volumes">get_volumes</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giodrive--has-media">has_media</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giodrive--has-volumes">has_volumes</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giodrive--is-media-check-automatic">is_media_check_automatic</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giodrive--is-media-removable">is_media_removable</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giodrive--poll-for-media">poll_for_media</link></methodname>
<methodparam><parameter role="keyword">callback</parameter></methodparam>
<methodparam><parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer></methodparam>
<methodparam><parameter role="keyword">user_data</parameter><initializer><literal>None</literal></initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giodrive--poll-for-media-finish">poll_for_media_finish</link></methodname>
<methodparam><parameter role="keyword">result</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobjectginterface">gobject.GInterface</link>
+-- <link linkend="class-giodrive">gio.Drive</link>
</synopsis>
</refsect1>
<refsect1>
<title>Prerequisites</title>
<para>
<link linkend="class-giodrive"><classname>gio.Drive</classname></link> requires
<link linkend="class-gobject"><classname>gobject.GObject</classname></link>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
<link linkend="class-giodrive"><classname>gio.Drive</classname></link>
- this represent a piece of hardware connected to the machine. Its generally
only created for removable hardware or hardware with removable media.
</para>
<para>
<link linkend="class-giodrive"><classname>gio.Drive</classname></link>
is a container class for GVolume objects that stem from the same piece of media.
As such, <link linkend="class-giodrive"><classname>gio.Drive</classname></link>
abstracts a drive with (or without) removable media and provides operations for
querying whether media is available, determing whether media change is automatically
detected and ejecting the media.
</para>
<para>
If the <link linkend="class-giodrive"><classname>gio.Drive</classname></link>
reports that media isn't automatically detected, one can poll for media; typically
one should not do this periodically as a poll for media operation is potententially
expensive and may spin up the drive creating noise.
</para>
<para>
For porting from GnomeVFS note that there is no equivalent of
<link linkend="class-giodrive"><classname>gio.Drive</classname></link>
in that API.
</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-giodrive--can-eject">
<title>gio.Drive.can_eject</title>
<programlisting><methodsynopsis language="python">
<methodname>can_eject</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the drive can be ejected,
<literal>False</literal> otherwise.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>can_eject</methodname>() method checks if a drive can be ejected.
</para>
</refsect2>
<refsect2 id="method-giodrive--can-poll-for-media">
<title>gio.Drive.can_poll_for_media</title>
<programlisting><methodsynopsis language="python">
<methodname>can_poll_for_media</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the drive can be polled
for media changes, <literal>False</literal> otherwise.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>can_poll_for_media</methodname>() method checks if a drive
can be polled for media changes.
</para>
</refsect2>
<refsect2 id="method-giodrive--eject">
<title>gio.Drive.eject</title>
<programlisting><methodsynopsis language="python">
<methodname>eject</methodname>
<methodparam>
<parameter role="keyword">callback</parameter>
</methodparam>
<methodparam>
<parameter role="keyword">flags</parameter><initializer><literal>gio.MOUNT_UNMOUNT_NONE</literal></initializer>
</methodparam>
<methodparam>
<parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer>
</methodparam>
<methodparam>
<parameter role="keyword">user_data</parameter><initializer><literal>None</literal></initializer>
</methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">callback</parameter> :</term>
<listitem><simpara>A GAsyncReadyCallback to call when the request is satisfied.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">flags</parameter> :</term>
<listitem><simpara>flags affecting the unmount if required for eject.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">cancellable</parameter> :</term>
<listitem><simpara>Optional
<link linkend="class-giocancellable"><classname>gio.Cancellable</classname></link>
object, <literal>None</literal> to ignore.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">user_data</parameter> :</term>
<listitem><simpara>The data to pass to callback function.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>eject</methodname>() method asynchronously ejects a drive.
</para>
<para>
When the operation is finished, callback will be called. You can then call
<methodname><link linkend="method-giodrive--eject-finish">gio.Drive.eject_finish</link></methodname>()
to obtain the result of the operation.
</para>
</refsect2>
<refsect2 id="method-giodrive--eject-finish">
<title>gio.Drive.eject_finish</title>
<programlisting><methodsynopsis language="python">
<methodname>eject_finish</methodname>
<methodparam><parameter role="keyword">result</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">result</parameter> :</term>
<listitem><simpara>a <link linkend="class-gioasyncresult"><classname>gio.AsyncResult</classname></link>.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the drive has been ejected
successfully, <literal>False</literal> otherwise.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>eject_finish</methodname>() method finishes ejecting a drive.
</para>
</refsect2>
<refsect2 id="method-giodrive--enumerate-identifiers">
<title>gio.Drive.enumerate_identifiers</title>
<programlisting><methodsynopsis language="python">
<methodname>enumerate_identifiers</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a list of strings containing kinds of identifiers.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>enumerate_identifiers</methodname>() method gets the kinds
of identifiers that drive has. Use
<methodname><link linkend="method-giodrive--get-identifier">gio.Drive.get_identifier</link></methodname>()
to obtain the identifiers themselves.
</para>
</refsect2>
<refsect2 id="method-giodrive--get-icon">
<title>gio.Drive.get_icon</title>
<programlisting><methodsynopsis language="python">
<methodname>get_icon</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><link linkend="class-gioicon"><classname>gio.Icon</classname></link>
for the drive.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_icon</methodname>() method gets the icon for drive.
</para>
</refsect2>
<refsect2 id="method-giodrive--get-identifier">
<title>gio.Drive.get_identifier</title>
<programlisting><methodsynopsis language="python">
<methodname>get_identifier</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A string containing the requested identfier, or
<literal>None</literal> if the
<link linkend="class-giodrive"><classname>gio.Drive</classname></link>
doesn't have this kind of identifier.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_identifier</methodname>() method gets the identifier of
the given kind for drive.
</para>
</refsect2>
<refsect2 id="method-giodrive--get-name">
<title>gio.Drive.get_name</title>
<programlisting><methodsynopsis language="python">
<methodname>get_name</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A string containing drive's name.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_name</methodname>() method gets the name of drive.
</para>
</refsect2>
<refsect2 id="method-giodrive--get-volumes">
<title>gio.Drive.get_volumes</title>
<programlisting><methodsynopsis language="python">
<methodname>get_volumes</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A list containing any
<link linkend="class-giovolume"><classname>gio.Volume</classname></link>
objects on the given drive.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_volumes</methodname>() method get a list of mountable
volumes for drive.
</para>
</refsect2>
<refsect2 id="method-giodrive--has-media">
<title>gio.Drive.has_media</title>
<programlisting><methodsynopsis language="python">
<methodname>has_media</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if drive has media,
<literal>False</literal> otherwise.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>has_media</methodname>() method checks if the drive
has media. Note that the OS may not be polling the drive for media changes; see
<methodname><link linkend="method-giodrive--is-media-check-automatic">gio.Drive.is_media_check_automatic</link></methodname>()
for more details.
</para>
</refsect2>
<refsect2 id="method-giodrive--has-volumes">
<title>gio.Drive.has_volumes</title>
<programlisting><methodsynopsis language="python">
<methodname>has_volumes</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if drive contains volumes,
<literal>False</literal> otherwise.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>has_volumes</methodname>() method check if drive has any mountable volumes.
</para>
</refsect2>
<refsect2 id="method-giodrive--is-media-check-automatic">
<title>gio.Drive.is_media_check_automatic</title>
<programlisting><methodsynopsis language="python">
<methodname>is_media_check_automatic</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if drive is capabable
of automatically detecting media changes,
<literal>False</literal> otherwise.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>is_media_check_automatic</methodname>() method checks if
drive is capabable of automatically detecting media changes.
</para>
</refsect2>
<refsect2 id="method-giodrive--is-media-removable">
<title>gio.Drive.is_media_removable</title>
<programlisting><methodsynopsis language="python">
<methodname>is_media_removable</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if drive supports removable media,
<literal>False</literal> otherwise.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>is_media_removable</methodname>() method checks if the
drive supports removable media.
</para>
</refsect2>
<refsect2 id="method-giodrive--poll-for-media">
<title>gio.Drive.poll_for_media</title>
<programlisting><methodsynopsis language="python">
<methodname>poll_for_media</methodname>
<methodparam>
<parameter role="keyword">callback</parameter>
</methodparam>
<methodparam>
<parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer>
</methodparam>
<methodparam>
<parameter role="keyword">user_data</parameter><initializer><literal>None</literal></initializer>
</methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">callback</parameter> :</term>
<listitem><simpara>A GAsyncReadyCallback to call when the request is satisfied.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">cancellable</parameter> :</term>
<listitem><simpara>Optional
<link linkend="class-giocancellable"><classname>gio.Cancellable</classname></link>
object, <literal>None</literal> to ignore.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">user_data</parameter> :</term>
<listitem><simpara>The data to pass to callback function.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>poll_for_media</methodname>() method asynchronously polls
drive to see if media has been inserted or removed.
</para>
<para>
When the operation is finished, callback will be called. You can then call
<methodname><link linkend="method-giodrive--poll-for-media-finish">gio.Drive.poll_for_media_finish</link></methodname>()
to obtain the result of the operation.
</para>
</refsect2>
<refsect2 id="method-giodrive--poll-for-media-finish">
<title>gio.Drive.poll_for_media_finish</title>
<programlisting><methodsynopsis language="python">
<methodname>poll_for_media_finish</methodname>
<methodparam><parameter role="keyword">result</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">result</parameter> :</term>
<listitem><simpara>a <link linkend="class-gioasyncresult"><classname>gio.AsyncResult</classname></link>.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the drive has been poll_for_mediaed
successfully, <literal>False</literal> otherwise.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>poll_for_media_finish</methodname>() method finishes
an operation started with
<methodname><link linkend="method-giodrive--poll-for-media">gio.Drive.poll_for_media</link></methodname>()
on a drive.
</para>
</refsect2>
</refsect1>
</refentry>
|
