Back to Seed Clases

Gio

Classes

Interfaces

Structs

Unions

Enums

Interface Gio.Volume

Import line:	Gio = imports.gi.Gio;
GIR File:	Gio-2.0.gir
C documentation:	GVolume
Interface :	Volume

The GVolume interface represents user-visible objects that can be
mounted. Note, when porting from GnomeVFS, GVolume is the moral
equivalent of GnomeVFSDrive.
Mounting a GVolume instance is an asynchronous operation. For more
information about asynchronous operations, see GAsyncReady and
GSimpleAsyncReady. To mount a GVolume, first call
g_volume_mount() with (at least) the GVolume instance, optionally
a GMountOperation object and a GAsyncReadyCallback.
Typically, one will only want to pass NULL for the
GMountOperation if automounting all volumes when a desktop session
starts since it's not desirable to put up a lot of dialogs asking
for credentials.
The callback will be fired when the operation has resolved (either
with success or failure), and a GAsyncReady structure will be
passed to the callback. That callback should then call
g_volume_mount_finish() with the GVolume instance and the
GAsyncReady data to see if the operation was completed
successfully. If an error is present when g_volume_mount_finish()
is called, then it will be filled with any error information.

It is sometimes necessary to directly access the underlying
operating system object behind a volume (e.g. for passing a volume
to an application via the commandline). For this purpose, GIO
allows to obtain an 'identifier' for the volume. There can be
different kinds of identifiers, such as Hal UDIs, filesystem labels,
traditional Unix devices (e.g. /dev/sda2),
uuids. GIO uses predefind strings as names for the different kinds
G_VOLUME_IDENTIFIER_KIND_LABEL, etc. Use g_volume_get_identifier()
to obtain an identifier for a volume.

Note that G_VOLUME_IDENTIFIER_KIND_HAL_UDI will only be available
when the gvfs hal volume monitor is in use. Other volume monitors
will generally be able to provide the G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE
identifier, which can be used to obtain a hal device by means of
libhal_manger_find_device_string_match().

Properties
None

Methods / Constructors
Method / Constructor		Defined By
	can_eject () : gboolean Checks if a volume can be ejected. Checks if a volume can be ejected. Returns: gboolean TRUE if the volume can be ejected. FALSE otherwise.	Gio.Volume
	can_mount () : gboolean Checks if a volume can be mounted. Checks if a volume can be mounted. Returns: gboolean TRUE if the volume can be mounted. FALSE otherwise.	Gio.Volume
	eject (MountUnmountFlags *flags, Cancellable cancellable, Function callback, void *user_data) : none Ejects a volume. Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_finish() with the volume* and GAsyncResult returned in the callback. Parameters: Gio.MountUnmountFlags flags Required (not null) flags affecting the unmount if required for eject Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Function (Object *source_object, AsyncResult res, void *user_data) : none a GAsyncReadyCallback, or NULL. void user_data Required (not null) user data that gets passed to callback Returns: none	Gio.Volume
	eject_finish (AsyncResult *result) : gboolean Finishes ejecting a volume. Finishes ejecting a volume. If any errors occured during the operation, Parameters: Gio.AsyncResult result* Required (not null) a GAsyncResult. Returns: gboolean TRUE, FALSE if operation failed.	Gio.Volume
	eject_with_operation (MountUnmountFlags *flags, MountOperation mount_operation, Cancellable cancellable, Function callback, void *user_data) : none Ejects a volume. Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_with_operation_finish() with the volume* and GAsyncResult data returned in the callback. Parameters: Gio.MountUnmountFlags flags Required (not null) flags affecting the unmount if required for eject Gio.MountOperation mount_operation a GMountOperation or NULL to avoid user interaction. Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Function (Object *source_object, AsyncResult res, void *user_data) : none Required (not null) a GAsyncReadyCallback, or NULL. void user_data Required (not null) user data passed to callback. Returns: none	Gio.Volume
	eject_with_operation_finish (AsyncResult *result) : gboolean Finishes ejecting a volume. Finishes ejecting a volume. If any errors occurred during the operation, Parameters: Gio.AsyncResult result* Required (not null) a GAsyncResult. Returns: gboolean TRUE if the volume was successfully ejected. FALSE otherwise.	Gio.Volume
	enumerate_identifiers () : Array Gets the kinds of identifiers that volume has. Gets the kinds of identifiers that volume has. Use g_volume_get_identifer() to obtain the identifiers themselves. of strings containing kinds of identifiers. Use g_strfreev() to free. Returns: Array a NULL-terminated array	Gio.Volume
	get_activation_root () : Gio.File Gets the activation root for a GVolume if it is known ahead of mount time. Gets the activation root for a GVolume if it is known ahead of mount time. Returns NULL otherwise. If not NULL and if volume is mounted, then the result of g_mount_get_root() on the GMount object obtained from g_volume_get_mount() will always either be equal or a prefix of what this function returns. In other words, in code GMount mount; GFile mount_root GFile volume_activation_root; mount = g_volume_get_mount (volume); / mounted, so never NULL / mount_root = g_mount_get_root (mount); volume_activation_root = g_volume_get_activation_root(volume); / assume not NULL / then the expression (g_file_has_prefix (volume_activation_root, mount_root) \|\| will always be TRUE. Activation roots are typically used in GVolumeMonitor* implementations to find the underlying mount to shadow, see g_mount_is_shadowed() for more details. g_object_unref() to free. Returns: Gio.File the activation root of volume or NULL. Use	Gio.Volume
	get_drive () : Gio.Drive Gets the drive for the volume. Gets the drive for the volume. The returned object should be unreffed with g_object_unref() when no longer needed. Returns: Gio.Drive a GDrive or NULL if volume is not associated with a drive.	Gio.Volume
	get_icon () : Gio.Icon Gets the icon for volume. Gets the icon for volume. The returned object should be unreffed with g_object_unref() when no longer needed. Returns: Gio.Icon a GIcon.	Gio.Volume
	get_identifier (String *kind) : String Gets the identifier of the given kind for volume. Gets the identifier of the given kind for volume. See the introduction for more information about volume identifiers. requested identfier, or NULL* if the GVolume doesn't have this kind of identifier Parameters: String kind Required (not null) the kind of identifier to return Returns: String a newly allocated string containing the	Gio.Volume
	get_mount () : Gio.Mount Gets the mount for the volume. Gets the mount for the volume. The returned object should be unreffed with g_object_unref() when no longer needed. Returns: Gio.Mount a GMount or NULL if volume isn't mounted.	Gio.Volume
	get_name () : String Gets the name of volume. Gets the name of volume. be freed with g_free() when no longer needed. Returns: String the name for the given volume. The returned string should	Gio.Volume
	get_uuid () : String Gets the UUID for the volume. Gets the UUID for the volume. The reference is typically based on the file system UUID for the volume in question and should be considered an opaque string. Returns NULL if there is no UUID available. The returned string should be freed with g_free() when no longer needed. Returns: String the UUID for volume or NULL if no UUID can be computed.	Gio.Volume
	mount (MountMountFlags *flags, MountOperation mount_operation, Cancellable cancellable, Function callback, void *user_data) : none Mounts a volume. Mounts a volume. This is an asynchronous operation, and is finished by calling g_volume_mount_finish() with the volume* and GAsyncResult returned in the callback. Parameters: Gio.MountMountFlags flags Required (not null) flags affecting the operation Gio.MountOperation mount_operation a GMountOperation or NULL to avoid user interaction. Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Function (Object *source_object, AsyncResult res, void *user_data) : none a GAsyncReadyCallback, or NULL. void user_data Required (not null) user data that gets passed to callback Returns: none	Gio.Volume
	mount_finish (AsyncResult *result) : gboolean Finishes mounting a volume. Finishes mounting a volume. If any errors occured during the operation, If the mount operation succeeded, g_volume_get_mount() on volume* is guaranteed to return the mount right after calling this function; there's no need to listen for the 'mount-added' signal on GVolumeMonitor. Parameters: Gio.AsyncResult result Required (not null) a GAsyncResult Returns: gboolean TRUE, FALSE if operation failed.	Gio.Volume
	should_automount () : gboolean Returns whether the volume should be automatically mounted. Returns whether the volume should be automatically mounted. Returns: gboolean TRUE if the volume should be automatically mounted.	Gio.Volume

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	changed (Volume *self) : none Emitted when the volume has been changed. Emitted when the volume has been changed. Parameters: Gio.Volume self* Returns: {none}	Gio.Volume
	removed (Volume *self) : none This signal is emitted when the GVolume* have been removed. This signal is emitted when the GVolume have been removed. If the recipient is holding references to the object they should release them so the object can be finalized. Parameters: Gio.Volume self Returns: {none}	Gio.Volume

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gio.Mount Method	get_volume () : Gio.Volume Gets the volume for the mount.
Gio.VolumeMonitor Signal	volume_added (VolumeMonitor *self, Volume volume*) : none Emitted when a mountable volume is added to the system.
Gio.VolumeMonitor Signal	volume_changed (VolumeMonitor *self, Volume volume*) : none Emitted when mountable volume is changed.
Gio.VolumeMonitor Signal	volume_removed (VolumeMonitor *self, Volume volume*) : none Emitted when a mountable volume is removed from the system.
Gio.VolumeMonitor Method	Gio.VolumeMonitor.adopt_orphan_mount (Mount *mount) : Gio.Volume This function should be called by any GVolumeMonitor* implementation when a new GMount object is created that is not associated with a GVolume object.
Gio.VolumeMonitor Method	get_volume_for_uuid (String *uuid) : Gio.Volume Finds a GVolume* object by its UUID (see g_volume_get_uuid()) Free the returned object with g_object_unref().