Back to Seed Clases

Gio

Classes

Interfaces

Structs

Unions

Enums

Interface Gio.Drive

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

GDrive - this represent a piece of hardware connected to the machine.
It's generally only created for removable hardware or hardware with
removable media.
GDrive is a container class for GVolume objects that stem from
the same piece of media. As such, GDrive 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.
If the GDrive 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.
GDrive supports starting and stopping drives with authentication
support for the former. This can be used to support a diverse set
of use cases including connecting/disconnecting iSCSI devices,
powering down external disk enclosures and starting/stopping
multi-disk devices such as RAID devices. Note that the actual
semantics and side-effects of starting/stopping a GDrive may vary
according to implementation. To choose the correct verbs in e.g. a
file manager, use g_drive_get_start_stop_type().
For porting from GnomeVFS note that there is no equivalent of
GDrive in that API.

Properties
None

Methods / Constructors
Method / Constructor		Defined By
	can_eject () : gboolean Checks if a drive can be ejected. Checks if a drive can be ejected. Returns: gboolean TRUE if the drive can be ejected, FALSE otherwise.	Gio.Drive
	can_poll_for_media () : gboolean Checks if a drive can be polled for media changes. Checks if a drive can be polled for media changes. FALSE otherwise. Returns: gboolean TRUE if the drive can be polled for media changes,	Gio.Drive
	can_start () : gboolean Checks if a drive can be started. Checks if a drive can be started. Returns: gboolean TRUE if the drive can be started, FALSE otherwise.	Gio.Drive
	can_start_degraded () : gboolean Checks if a drive can be started degraded. Checks if a drive can be started degraded. Returns: gboolean TRUE if the drive can be started degraded, FALSE otherwise.	Gio.Drive
	can_stop () : gboolean Checks if a drive can be stopped. Checks if a drive can be stopped. Returns: gboolean TRUE if the drive can be stopped, FALSE otherwise.	Gio.Drive
	eject (MountUnmountFlags *flags, Cancellable cancellable, Function callback, void *user_data) : none Asynchronously ejects a drive. Asynchronously ejects a drive. When the operation is finished, callback* will be called. You can then call g_drive_eject_finish() to obtain the result of the operation. 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 to pass to callback Returns: none	Gio.Drive
	eject_finish (AsyncResult *result) : gboolean Finishes ejecting a drive. Finishes ejecting a drive. FALSE* otherwise. Parameters: Gio.AsyncResult result Required (not null) a GAsyncResult. Returns: gboolean TRUE if the drive has been ejected successfully,	Gio.Drive
	eject_with_operation (MountUnmountFlags *flags, MountOperation mount_operation, Cancellable cancellable, Function callback, void *user_data) : none Ejects a drive. Ejects a drive. This is an asynchronous operation, and is finished by calling g_drive_eject_with_operation_finish() with the drive* 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 a GAsyncReadyCallback, or NULL. void user_data Required (not null) user data passed to callback. Returns: none	Gio.Drive
	eject_with_operation_finish (AsyncResult *result) : gboolean Finishes ejecting a drive. Finishes ejecting a drive. If any errors occurred during the operation, Parameters: Gio.AsyncResult result* Required (not null) a GAsyncResult. Returns: gboolean TRUE if the drive was successfully ejected. FALSE otherwise.	Gio.Drive
	enumerate_identifiers () : Array Gets the kinds of identifiers that drive has. Gets the kinds of identifiers that drive has. Use g_drive_get_identifer() to obtain the identifiers themselves. array of strings containing kinds of identifiers. Use g_strfreev() to free. Returns: Array a NULL-terminated	Gio.Drive
	get_icon () : Gio.Icon Gets the icon for drive. Gets the icon for drive. Free the returned object with g_object_unref(). Returns: Gio.Icon GIcon for the drive.	Gio.Drive
	get_identifier (String *kind) : String Gets the identifier of the given kind for drive. Gets the identifier of the given kind for drive. requested identfier, or NULL* if the GDrive 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.Drive
	get_name () : String Gets the name of drive. Gets the name of drive. string should be freed when no longer needed. Returns: String a string containing drive's name. The returned	Gio.Drive
	get_start_stop_type () : Gio.DriveStartStopType Gets a hint about how a drive can be started/stopped. Gets a hint about how a drive can be started/stopped. Returns: Gio.DriveStartStopType A value from the GDriveStartStopType enumeration.	Gio.Drive
	get_volumes () : Array Get a list of mountable volumes for drive. Get a list of mountable volumes for drive. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). Returns: Array GList containing any GVolume objects on the given drive.	Gio.Drive
	has_media () : gboolean Checks if the drive has media. Checks if the drive has media. Note that the OS may not be polling the drive for media changes; see g_drive_is_media_check_automatic() for more details. Returns: gboolean TRUE if drive has media, FALSE otherwise.	Gio.Drive
	has_volumes () : gboolean Check if drive has any mountable volumes. Check if drive has any mountable volumes. Returns: gboolean TRUE if the drive contains volumes, FALSE otherwise.	Gio.Drive
	is_media_check_automatic () : gboolean Checks if drive is capabable of automatically detecting media changes. Checks if drive is capabable of automatically detecting media changes. media changes, FALSE otherwise. Returns: gboolean TRUE if the drive is capabable of automatically detecting	Gio.Drive
	is_media_removable () : gboolean Checks if the drive supports removable media. Checks if the drive supports removable media. Returns: gboolean TRUE if drive supports removable media, FALSE otherwise.	Gio.Drive
	poll_for_media (Cancellable *cancellable, Function callback, void *user_data) : none Asynchronously polls drive* to see if media has been inserted or removed. Asynchronously polls drive to see if media has been inserted or removed. When the operation is finished, callback will be called. You can then call g_drive_poll_for_media_finish() to obtain the result of the operation. Parameters: 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 to pass to callback Returns: none	Gio.Drive
	poll_for_media_finish (AsyncResult *result) : gboolean Finishes an operation started with g_drive_poll_for_media() on a drive. Finishes an operation started with g_drive_poll_for_media() on a drive. FALSE* otherwise. Parameters: Gio.AsyncResult result Required (not null) a GAsyncResult. Returns: gboolean TRUE if the drive has been poll_for_mediaed successfully,	Gio.Drive
	start (DriveStartFlags *flags, MountOperation mount_operation, Cancellable cancellable, Function callback, void *user_data) : none Asynchronously starts a drive. Asynchronously starts a drive. When the operation is finished, callback* will be called. You can then call g_drive_start_finish() to obtain the result of the operation. Parameters: Gio.DriveStartFlags flags Required (not null) flags affecting the start 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 to pass to callback Returns: none	Gio.Drive
	start_finish (AsyncResult *result) : gboolean Finishes starting a drive. Finishes starting a drive. FALSE* otherwise. Parameters: Gio.AsyncResult result Required (not null) a GAsyncResult. Returns: gboolean TRUE if the drive has been started successfully,	Gio.Drive
	stop (MountUnmountFlags *flags, MountOperation mount_operation, Cancellable cancellable, Function callback, void *user_data) : none Asynchronously stops a drive. Asynchronously stops a drive. When the operation is finished, callback* will be called. You can then call g_drive_stop_finish() to obtain the result of the operation. Parameters: Gio.MountUnmountFlags flags Required (not null) flags affecting the unmount if required for stopping. 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 to pass to callback Returns: none	Gio.Drive
	stop_finish (AsyncResult *result) : gboolean Finishes stopping a drive. Finishes stopping a drive. FALSE* otherwise. Parameters: Gio.AsyncResult result Required (not null) a GAsyncResult. Returns: gboolean TRUE if the drive has been stopped successfully,	Gio.Drive

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	changed (Drive *self) : none Emitted when the drive's state has changed. Emitted when the drive's state has changed. Parameters: Gio.Drive self* Returns: {none}	Gio.Drive
	disconnected (Drive *self) : none This signal is emitted when the GDrive* have been disconnected. This signal is emitted when the GDrive have been disconnected. If the recipient is holding references to the object they should release them so the object can be finalized. Parameters: Gio.Drive self Returns: {none}	Gio.Drive
	eject_button (Drive *self) : none Emitted when the physical eject button (if any) of a drive has been pressed. Emitted when the physical eject button (if any) of a drive has been pressed. Parameters: Gio.Drive self* Returns: {none}	Gio.Drive
	stop_button (Drive *self) : none Emitted when the physical stop button (if any) of a drive has been pressed. Emitted when the physical stop button (if any) of a drive has been pressed. Parameters: Gio.Drive self* Returns: {none}	Gio.Drive

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gio.Mount Method	get_drive () : Gio.Drive Gets the drive for the mount.
Gio.Volume Method	get_drive () : Gio.Drive Gets the drive for the volume.
Gio.VolumeMonitor Signal	drive_changed (VolumeMonitor *self, Drive drive*) : none Emitted when a drive changes.
Gio.VolumeMonitor Signal	drive_connected (VolumeMonitor *self, Drive drive*) : none Emitted when a drive is connected to the system.
Gio.VolumeMonitor Signal	drive_disconnected (VolumeMonitor *self, Drive drive*) : none Emitted when a drive is disconnected from the system.
Gio.VolumeMonitor Signal	drive_eject_button (VolumeMonitor *self, Drive drive) : none Emitted when the eject button is pressed on drive*.
Gio.VolumeMonitor Signal	drive_stop_button (VolumeMonitor *self, Drive drive) : none Emitted when the stop button is pressed on drive*.