Gio::Drive Class Reference
Virtual File System drive management. More...
Inherits Glib::Interface.
List of all members.
Detailed Description
Virtual File System drive management.
This represent a piece of hardware connected to the machine. It's generally only created for removable hardware or hardware with removable media. Gio::Drive is a container class for Gio::Volume objects that stem from the same piece of media. As such, Gio::Drive 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 Gio::Drive 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.
- Since glibmm 2.16:
Constructor & Destructor Documentation
virtual Gio::Drive::~Drive |
( |
|
) |
[virtual] |
Member Function Documentation
static void Gio::Drive::add_interface |
( |
GType |
gtype_implementer |
) |
[static] |
bool Gio::Drive::can_eject |
( |
|
) |
const |
Checks if a drive can be ejected.
- Returns:
true
if the drive can be ejected, false
otherwise.
bool Gio::Drive::can_poll_for_media |
( |
|
) |
const |
Checks if a drive can be polled for media changes.
- Returns:
true
if the drive can be polled for media changes, false
otherwise.
Ejects the drive.
- Parameters:
-
| slot | A callback which will be called when the eject is completed. |
| flags | Flags affecting the unmount if required for eject. |
Ejects the drive.
- Parameters:
-
| slot | A callback which will be called when the eject is completed. |
| flags | Flags affecting the unmount if required for eject. |
Ejects the drive.
- Parameters:
-
| slot | A callback which will be called when the eject is completed or canceled. |
| flags | Flags affecting the unmount if required for eject. |
| cancellable | A cancellable object which can be used to cancel the eject. |
Finishes ejecting a drive.
- Parameters:
-
- Returns:
true
if the drive has been ejected successfully, false
otherwise.
Gets the kinds of identifiers that drive has.
Use Glib::drive_get_identifer() to obtain the identifiers themselves.
- Returns:
- A
0
-terminated array of strings containing kinds of identifiers. Use Glib::strfreev() to free.
Gets the icon for drive.
- Returns:
- Icon for the drive. Free the returned object with Glib::object_unref().
Gets the icon for drive.
- Returns:
- Icon for the drive. Free the returned object with Glib::object_unref().
Gets the identifier of the given kind for drive.
- Parameters:
-
| kind | The kind of identifier to return. |
- Returns:
- A newly allocated string containing the requested identfier, or
0
if the Drive doesn't have this kind of identifier.
Gets the name of drive.
- Returns:
- A string containing drive's name. The returned string should be freed when no longer needed.
Get a list of mountable volumes for drive.
The returned list should be freed with Glib::list_free(), after its elements have been unreffed with Glib::object_unref().
- Returns:
- List containing any Volume objects on the given drive.
const GDrive* Gio::Drive::gobj |
( |
|
) |
const [inline] |
Provides access to the underlying C GObject.
Reimplemented from Glib::Interface.
GDrive* Gio::Drive::gobj |
( |
|
) |
[inline] |
Provides access to the underlying C GObject.
Reimplemented from Glib::Interface.
bool Gio::Drive::has_media |
( |
|
) |
const |
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:
true
if drive has media, false
otherwise.
bool Gio::Drive::has_volumes |
( |
|
) |
const |
Check if drive has any mountable volumes.
- Returns:
true
if the drive contains volumes, false
otherwise.
bool Gio::Drive::is_media_check_automatic |
( |
|
) |
const |
Checks if drive is capabable of automatically detecting media changes.
- Returns:
true
if the drive is capabable of automatically detecting media changes, false
otherwise.
bool Gio::Drive::is_media_removable |
( |
|
) |
const |
Checks if the drive supports removable media.
- Returns:
true
if drive supports removable media, false
otherwise.
void Gio::Drive::poll_for_media |
( |
|
) |
|
Polls drive to see if media has been inserted or removed.
Polls drive to see if media has been inserted or removed.
- Parameters:
-
| slot | A callback which will be called when the poll is completed. |
Polls drive to see if media has been inserted or removed.
- Parameters:
-
| slot | A callback which will be called when the poll is completed. |
| cancellable | A cancellable object which can be used to cancel the operation. |
Finishes an operation started with g_drive_poll_for_media() on a drive.
- Parameters:
-
- Returns:
true
if the drive has been poll_for_mediaed successfully, false
otherwise.
Friends And Related Function Documentation
A Glib::wrap() method for this object.
- Parameters:
-
| object | The C instance. |
| take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |
- Returns:
- A C++ instance that wraps this C instance.
The documentation for this class was generated from the following file: