GNOME_IS_VFS_DRIVE()

#define GNOME_IS_VFS_DRIVE(o)       (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNOME_VFS_TYPE_DRIVE))

GNOME_IS_VFS_DRIVE_CLASS()

#define GNOME_IS_VFS_DRIVE_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), GNOME_VFS_TYPE_DRIVE))

GNOME_VFS_TYPE_DRIVE

#define GNOME_VFS_TYPE_DRIVE        (gnome_vfs_drive_get_type ())

GNOME_VFS_DRIVE()

#define GNOME_VFS_DRIVE(o)          (G_TYPE_CHECK_INSTANCE_CAST ((o), GNOME_VFS_TYPE_DRIVE, GnomeVFSDrive))

GNOME_VFS_DRIVE_CLASS()

#define GNOME_VFS_DRIVE_CLASS(k)    (G_TYPE_CHECK_CLASS_CAST((k), GNOME_VFS_TYPE_DRIVE, GnomeVFSDriveClass))

gnome_vfs_drive_compare ()

gint
gnome_vfs_drive_compare (GnomeVFSDrive *a,
                         GnomeVFSDrive *b);

Compares two GnomeVFSDrive objects a and b . Two GnomeVFSDrive objects referring to different drives are guaranteed to not return 0 when comparing them, if they refer to the same drive 0 is returned.

The resulting gint should be used to determine the order in which a and b are displayed in graphical user interfces.

The comparison algorithm first of all peeks the device type of a and b , they will be sorted in the following order:

Afterwards, the display name of a and b is compared using a locale-sensitive sorting algorithm, which involves g_utf8_collate_key().

If two drives have the same display name, their unique ID is compared which can be queried using gnome_vfs_drive_get_id().

Since: 2.6

gnome_vfs_drive_eject ()

void
gnome_vfs_drive_eject (GnomeVFSDrive *drive,
                       GnomeVFSVolumeOpCallback callback,
                       gpointer user_data);

If drive has associated GnomeVFSVolume objects, all of them will be unmounted by calling gnome_vfs_volume_unmount() for each volume in gnome_vfs_drive_get_mounted_volumes(), except for the last one, for which gnome_vfs_volume_eject() is called to ensure that the drive 's media is ejected.

If drive however has no associated GnomeVFSVolume objects, it simply calls an unmount helper on the drive .

Since: 2.6

gnome_vfs_drive_get_activation_uri ()

char *
gnome_vfs_drive_get_activation_uri (GnomeVFSDrive *drive);

Returns the activation URI of a GnomeVFSDrive.

The returned URI usually refers to a valid location. You can check the validity of the location by calling gnome_vfs_uri_new() with the URI, and checking whether the return value is not NULL.

Since: 2.6

gnome_vfs_drive_get_device_path ()

char *
gnome_vfs_drive_get_device_path (GnomeVFSDrive *drive);

Returns the device path of a GnomeVFSDrive.

For HAL drives, this returns the value of the drives's "block.device" key. For UNIX mounts, it returns the mntent's mnt_fsname entry.

Otherwise, it returns NULL.

Since: 2.6

gnome_vfs_drive_get_device_type ()

GnomeVFSDeviceType
gnome_vfs_drive_get_device_type (GnomeVFSDrive *drive);

Since: 2.6

gnome_vfs_drive_get_display_name ()

char *
gnome_vfs_drive_get_display_name (GnomeVFSDrive *drive);

Since: 2.6

gnome_vfs_drive_get_hal_udi ()

char *
gnome_vfs_drive_get_hal_udi (GnomeVFSDrive *drive);

Returns the HAL UDI of a GnomeVFSDrive.

For HAL drives, this matches the value of the "info.udi" key, for other drives it is NULL.

Since: 2.6

gnome_vfs_drive_get_icon ()

char *
gnome_vfs_drive_get_icon (GnomeVFSDrive *drive);

Since: 2.6

gnome_vfs_drive_get_id ()

gulong
gnome_vfs_drive_get_id (GnomeVFSDrive *drive);

Since: 2.6

gnome_vfs_drive_get_mounted_volume ()

GnomeVFSVolume *
gnome_vfs_drive_get_mounted_volume (GnomeVFSDrive *drive);

Returns the first mounted volume for the drive .

Since: 2.6

gnome_vfs_drive_get_mounted_volumes ()

GList *
gnome_vfs_drive_get_mounted_volumes (GnomeVFSDrive *drive);

Since: 2.8

gnome_vfs_drive_volume_list_free ()

void
gnome_vfs_drive_volume_list_free (GList *volumes);

Frees the list volumes , if it is not NULL.

Since: 2.8

gnome_vfs_drive_get_type ()

GType
gnome_vfs_drive_get_type (void);

gnome_vfs_drive_is_connected ()

gboolean
gnome_vfs_drive_is_connected (GnomeVFSDrive *drive);

Since: 2.6

gnome_vfs_drive_is_mounted ()

gboolean
gnome_vfs_drive_is_mounted (GnomeVFSDrive *drive);

Since: 2.6

gnome_vfs_drive_is_user_visible ()

gboolean
gnome_vfs_drive_is_user_visible (GnomeVFSDrive *drive);

Returns whether the drive is visible to the user. This should be used by applications to determine whether it is included in user interfaces listing available drives.

Since: 2.6

gnome_vfs_drive_mount ()

void
gnome_vfs_drive_mount (GnomeVFSDrive *drive,
                       GnomeVFSVolumeOpCallback callback,
                       gpointer user_data);

Since: 2.6

gnome_vfs_drive_ref ()

GnomeVFSDrive *
gnome_vfs_drive_ref (GnomeVFSDrive *drive);

Increases the refcount of the drive by 1, if it is not NULL.

Since: 2.6

gnome_vfs_drive_unmount ()

void
gnome_vfs_drive_unmount (GnomeVFSDrive *drive,
                         GnomeVFSVolumeOpCallback callback,
                         gpointer user_data);

gnome_vfs_drive_unmount() invokes gnome_vfs_drive_eject(), if the drive signals that it should be ejected when it is unmounted. This may be true for CD-ROMs, USB sticks and other devices, depending on the backend providing the GnomeVFSDrive drive .

If the drive does not signal that it should be ejected when it is unmounted, gnome_vfs_drive_unmount() calls gnome_vfs_volume_unmount() for each of the drive 's mounted GnomeVFSVolumes, which can be queried using gnome_vfs_drive_get_mounted_volumes().

Since: 2.6

gnome_vfs_drive_unref ()

void
gnome_vfs_drive_unref (GnomeVFSDrive *drive);

Decreases the refcount of the drive by 1, if it is not NULL.

Since: 2.6

enum GnomeVFSDeviceType

Identifies the device type of a GnomeVFSVolume or a GnomeVFSDrive.

GnomeVFSDrive

typedef struct _GnomeVFSDrive GnomeVFSDrive;

struct GnomeVFSDriveClass

struct GnomeVFSDriveClass {
	GObjectClass parent_class;

	void (* volume_mounted)	  	(GnomeVFSDrive *drive,
				   	 GnomeVFSVolume *volume);
	void (* volume_pre_unmount) (GnomeVFSDrive *drive,
				   	 GnomeVFSVolume *volume);
	void (* volume_unmounted) (GnomeVFSDrive *drive,
				   	 GnomeVFSVolume *volume);
};

The “volume-mounted” signal

void
user_function (GnomeVFSDrive  *drive,
               GnomeVFSVolume *volume,
               gpointer        user_data)

This signal is emitted after the GnomeVFSVolume volume has been mounted.

When the volume is mounted, it is added to the drive 's list of mounted volumes, which can be queried using gnome_vfs_drive_get_mounted_volumes().

It is also added to the list of the GnomeVFSVolumeMonitor's list of mounted volumes, which can be queried using gnome_vfs_volume_monitor_get_mounted_volumes().

Flags: Run First

The “volume-pre-unmount” signal

void
user_function (GnomeVFSDrive  *drive,
               GnomeVFSVolume *volume,
               gpointer        user_data)

This signal is emitted when the GnomeVFSVolume volume , which has been present in the GnomeVFSDrive drive , is about to be unmounted.

When the volume is unmounted, it is removed from the drive 's list of mounted volumes, which can be queried using gnome_vfs_drive_get_mounted_volumes().

It is also removed from the GnomeVFSVolumeMonitor's list of mounted volumes, which can be queried using gnome_vfs_volume_monitor_get_mounted_volumes().

When a client application receives this signal, it must free all resources associated with the volume , for instance cancel all pending file operations on the volume , and cancel all pending file monitors using gnome_vfs_monitor_cancel().

Flags: Run First

The “volume-unmounted” signal

void
user_function (GnomeVFSDrive  *drive,
               GnomeVFSVolume *volume,
               gpointer        user_data)

This signal is emitted after the GnomeVFSVolume volume , which had been present in the GnomeVFSDrive drive , has been unmounted.

When the volume is unmounted, it is removed from the drive 's list of mounted volumes, which can be queried using gnome_vfs_drive_get_mounted_volumes().

It is also removed from the GnomeVFSVolumeMonitor's list of mounted volumes, which can be queried using gnome_vfs_volume_monitor_get_mounted_volumes().

Flags: Run First