From 76e9dc74ac706a9207f9d31f887d6e38df2a678f Mon Sep 17 00:00:00 2001 From: Gian Mario Tagliaretti Date: Mon, 25 May 2009 20:20:38 +0200 Subject: Update the docs with new 2.20 API --- docs/reference/pygio-mount.xml | 156 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 156 insertions(+) (limited to 'docs/reference/pygio-mount.xml') diff --git a/docs/reference/pygio-mount.xml b/docs/reference/pygio-mount.xml index f5688c5..f4b1c99 100644 --- a/docs/reference/pygio-mount.xml +++ b/docs/reference/pygio-mount.xml @@ -73,6 +73,10 @@ force_rescan cancellableNone + + is_shadowed + + remount callback @@ -85,6 +89,10 @@ remount_finish result + + shadow + + unmount callback @@ -96,6 +104,10 @@ unmount_finish result + + unshadow + + @@ -124,6 +136,16 @@ gobject.GObject Signal Prototypes + + "aborted" + + callback + mount + user_param1 + ... + + + "changed" @@ -565,6 +587,58 @@ for the asynchronous version. + + + gio.Mount.is_shadowed + + + is_shadowed + + + + + + Returns : + True if mount is shadowed. + + + + + + The is_shadowed() method determines if mount + is shadowed. Applications or libraries should avoid displaying mount + in the user interface if it is shadowed. + + + A mount is said to be shadowed if there exists one or more user visible + objects (currently + gio.Mount + objects) with a root that is inside the root of mount. + + + One application of shadow mounts is when exposing a single file system + that is used to address several logical volumes. In this situation, a + gio.VolumeMonitor + implementation would create two + gio.Volume + objects (for example, one for the camera functionality of the device + and one for a SD card reader on the device) with activation URIs + gphoto2://[usb:001,002]/store1/ and gphoto2://[usb:001,002]/store2/. + When the underlying mount (with root gphoto2://[usb:001,002]/) is + mounted, said + gio.VolumeMonitor + implementation would create two + gio.Mount + objects (each with their root matching the corresponding volume + activation root) that would shadow the original mount. + + + The proxy monitor in GVfs 2.26 and later, automatically creates and + manage shadow mounts (and shadows the underlying mount) if the activation + root on a gio.Volume + is set. + + gio.Mount.remount @@ -651,6 +725,29 @@ The remount_finish() method finishes remounting a mount. + + + gio.Mount.shadow + + + shadow + + + + + + + + The shadow() method increments the shadow + count on mount. Usually used by + gio.VolumeMonitor + implementations when creating a shadow mount for mount, see + gio.Mount.is_shadowed() + for more information. The caller will need to emit the "changed" + signal on mount manually. + + + gio.Mount.unmount @@ -730,11 +827,70 @@ The unmount_finish() method finishes unmounting a mount. + + + gio.Mount.unshadow + + + unshadow + + + + + + + + The unshadow() method decrements the shadow + count on mount. Usually used by + gio.VolumeMonitor + implementations when destroying a shadow mount for mount, see + gio.Mount.is_shadowed() + for more information. The caller will need to emit the "changed" + signal on mount manually. + + + Signals + + The "aborted" gio.Mount Signal + + callback + mount + user_param1 + ... + + + + + mount : + the mount + + + user_param1 : + the first user parameter (if any) specified + with the connect() + method + + + ... : + additional user parameters (if any) + + + + + Emitted by the backend when e.g. a device becomes unavailable while a + mount operation is in progress. + + + Implementations of gio.MountOperation + should handle this signal by dismissing open password dialogs. + + The "changed" gio.Mount Signal -- cgit