glibmm 2.82.0
|
Virtual File System drive management. More...
#include <giomm/drive.h>
Public Types | |
enum class | StartFlags { StartFlags::NONE = 0x0 } |
Flags used when starting a drive. More... | |
enum class | StartStopType { StartStopType::UNKNOWN , StartStopType::SHUTDOWN , StartStopType::NETWORK , StartStopType::MULTIDISK , StartStopType::PASSWORD } |
Enumeration describing how a drive can be started/stopped. More... | |
Public Member Functions | |
Drive (Drive &&src) noexcept | |
Drive & | operator= (Drive &&src) noexcept |
~Drive () noexcept override | |
GDrive * | gobj () |
Provides access to the underlying C GObject. | |
const GDrive * | gobj () const |
Provides access to the underlying C GObject. | |
Glib::ustring | get_name () const |
Gets the name of drive. | |
Glib::RefPtr< Icon > | get_icon () |
Gets the icon for drive. | |
Glib::RefPtr< const Icon > | get_icon () const |
Gets the icon for drive. | |
Glib::RefPtr< Icon > | get_symbolic_icon () |
Gets the icon for drive. | |
Glib::RefPtr< const Icon > | get_symbolic_icon () const |
Gets the icon for drive. | |
bool | has_volumes () const |
Check if drive has any mountable volumes. | |
std::vector< Glib::RefPtr< Volume > > | get_volumes () |
Get a list of mountable volumes for drive. | |
bool | is_media_removable () const |
Checks if the drive supports removable media. | |
bool | is_removable () const |
Checks if the Drive and/or its media is considered removable by the user. | |
bool | has_media () const |
Checks if the drive has media. | |
bool | is_media_check_automatic () const |
Checks if drive is capable of automatically detecting media changes. | |
bool | can_poll_for_media () const |
Checks if a drive can be polled for media changes. | |
bool | can_eject () const |
Checks if a drive can be ejected. | |
void | eject (const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable, Mount::UnmountFlags flags=Mount::UnmountFlags::NONE) |
Ejects the drive. | |
void | eject (const SlotAsyncReady &slot, Mount::UnmountFlags flags=Mount::UnmountFlags::NONE) |
Ejects the drive. | |
void | eject (const Glib::RefPtr< MountOperation > &mount_operation, const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable, Mount::UnmountFlags flags=Mount::UnmountFlags::NONE) |
void | eject (const Glib::RefPtr< MountOperation > &mount_operation, const SlotAsyncReady &slot, Mount::UnmountFlags flags=Mount::UnmountFlags::NONE) |
void | eject (Mount::UnmountFlags flags=Mount::UnmountFlags::NONE) |
Ejects the drive. | |
void | eject (const Glib::RefPtr< MountOperation > &mount_operation, Mount::UnmountFlags flags=Mount::UnmountFlags::NONE) |
bool | eject_finish (const Glib::RefPtr< AsyncResult > &result) |
Finishes ejecting a drive. | |
void | poll_for_media (const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable) |
Polls drive to see if media has been inserted or removed. | |
void | poll_for_media (const SlotAsyncReady &slot) |
Polls drive to see if media has been inserted or removed. | |
void | poll_for_media () |
Polls drive to see if media has been inserted or removed. | |
bool | poll_for_media_finish (const Glib::RefPtr< AsyncResult > &result) |
Finishes an operation started with g_drive_poll_for_media() on a drive. | |
std::string | get_identifier (const std::string &kind) const |
Gets the identifier of the given kind for drive. | |
std::vector< Glib::ustring > | enumerate_identifiers () const |
Gets the kinds of identifiers that drive has. | |
void | start (const Glib::RefPtr< MountOperation > &mount_operation, const Glib::RefPtr< Cancellable > &cancellable, const SlotAsyncReady &slot, StartFlags flags=StartFlags::NONE) |
void | start (const Glib::RefPtr< MountOperation > &mount_operation, const SlotAsyncReady &slot, StartFlags flags=StartFlags::NONE) |
bool | start_finish (const Glib::RefPtr< AsyncResult > &result) |
Finishes starting a drive. | |
bool | can_start () const |
bool | can_start_degraded () const |
void | stop (const Glib::RefPtr< MountOperation > &mount_operation, const Glib::RefPtr< Cancellable > &cancellable, const SlotAsyncReady &slot, Mount::UnmountFlags flags=Mount::UnmountFlags::NONE) |
void | stop (const Glib::RefPtr< MountOperation > &mount_operation, const SlotAsyncReady &slot, Mount::UnmountFlags flags=Mount::UnmountFlags::NONE) |
bool | stop_finish (const Glib::RefPtr< AsyncResult > &result) |
Finishes stopping a drive. | |
bool | can_stop () const |
StartStopType | get_start_stop_type () const |
Gets a hint about how a drive can be started/stopped. | |
Glib::ustring | get_sort_key () const |
Gets the sort key for drive, if any. | |
Glib::SignalProxy< void()> | signal_changed () |
Glib::SignalProxy< void()> | signal_disconnected () |
Glib::SignalProxy< void()> | signal_eject_button () |
Glib::SignalProxy< void()> | signal_stop_button () |
Public Member Functions inherited from Glib::Interface | |
Interface () | |
A Default constructor. | |
Interface (Interface &&src) noexcept | |
Interface & | operator= (Interface &&src) noexcept |
Interface (const Glib::Interface_Class &interface_class) | |
Called by constructors of derived classes. | |
Interface (GObject *castitem) | |
Called by constructors of derived classes. | |
~Interface () noexcept override | |
Interface (const Interface &)=delete | |
Interface & | operator= (const Interface &)=delete |
GObject * | gobj () |
const GObject * | gobj () const |
Public Member Functions inherited from Glib::ObjectBase | |
ObjectBase (const ObjectBase &)=delete | |
ObjectBase & | operator= (const ObjectBase &)=delete |
void | set_property_value (const Glib::ustring & property_name, const Glib::ValueBase & value) |
You probably want to use a specific property_*() accessor method instead. | |
void | get_property_value (const Glib::ustring & property_name, Glib::ValueBase & value) const |
You probably want to use a specific property_*() accessor method instead. | |
template<class PropertyType > | |
void | set_property (const Glib::ustring & property_name, const PropertyType & value) |
You probably want to use a specific property_*() accessor method instead. | |
template<class PropertyType > | |
void | get_property (const Glib::ustring & property_name, PropertyType & value) const |
You probably want to use a specific property_*() accessor method instead. | |
template<class PropertyType > | |
PropertyType | get_property (const Glib::ustring & property_name) const |
You probably want to use a specific property_*() accessor method instead. | |
sigc::connection | connect_property_changed (const Glib::ustring & property_name, const sigc::slot< void()> &slot) |
You can use the signal_changed() signal of the property proxy instead. | |
sigc::connection | connect_property_changed (const Glib::ustring & property_name, sigc::slot< void()> &&slot) |
You can use the signal_changed() signal of the property proxy instead. | |
void | freeze_notify () |
Increases the freeze count on object. | |
void | thaw_notify () |
Reverts the effect of a previous call to freeze_notify(). | |
virtual void | reference () const |
Increment the reference count for this object. | |
virtual void | unreference () const |
Decrement the reference count for this object. | |
GObject * | gobj () |
Provides access to the underlying C GObject. | |
const GObject * | gobj () const |
Provides access to the underlying C GObject. | |
GObject * | gobj_copy () const |
Give a ref-ed copy to someone. Use for direct struct access. | |
Static Public Member Functions | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
Protected Member Functions | |
Drive () | |
You should derive from this class to use it. | |
virtual void | on_changed () |
This is a default handler for the signal signal_changed(). | |
virtual void | on_disconnected () |
This is a default handler for the signal signal_disconnected(). | |
virtual void | on_eject_button () |
This is a default handler for the signal signal_eject_button(). | |
virtual void | on_stop_button () |
This is a default handler for the signal signal_stop_button(). | |
Protected Member Functions inherited from Glib::ObjectBase | |
ObjectBase () | |
This default constructor is called implicitly from the constructor of user-derived classes, even if, for instance, Gtk::Button calls a different ObjectBase constructor. | |
ObjectBase (const char *custom_type_name) | |
A derived constructor always overrides this choice. | |
ObjectBase (const std::type_info &custom_type_info) | |
This constructor is a special feature to allow creation of derived types on the fly, without having to use g_object_new() manually. | |
ObjectBase (ObjectBase &&src) noexcept | |
ObjectBase & | operator= (ObjectBase &&src) noexcept |
virtual | ~ObjectBase () noexcept=0 |
void | initialize (GObject *castitem) |
void | initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper) |
Related Symbols | |
(Note that these are not member symbols.) | |
Glib::RefPtr< Gio::Drive > | wrap (GDrive *object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
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.
|
protected |
You should derive from this class to use it.
|
noexcept |
|
overridenoexcept |
bool Gio::Drive::can_eject | ( | ) | const |
Checks if a drive can be ejected.
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.
true
if the drive can be polled for media changes, false
otherwise. bool Gio::Drive::can_start | ( | ) | const |
bool Gio::Drive::can_start_degraded | ( | ) | const |
bool Gio::Drive::can_stop | ( | ) | const |
void Gio::Drive::eject | ( | const Glib::RefPtr< MountOperation > & | mount_operation, |
const SlotAsyncReady & | slot, | ||
const Glib::RefPtr< Cancellable > & | cancellable, | ||
Mount::UnmountFlags | flags = Mount::UnmountFlags::NONE |
||
) |
void Gio::Drive::eject | ( | const Glib::RefPtr< MountOperation > & | mount_operation, |
const SlotAsyncReady & | slot, | ||
Mount::UnmountFlags | flags = Mount::UnmountFlags::NONE |
||
) |
void Gio::Drive::eject | ( | const Glib::RefPtr< MountOperation > & | mount_operation, |
Mount::UnmountFlags | flags = Mount::UnmountFlags::NONE |
||
) |
void Gio::Drive::eject | ( | const SlotAsyncReady & | slot, |
const Glib::RefPtr< Cancellable > & | cancellable, | ||
Mount::UnmountFlags | flags = Mount::UnmountFlags::NONE |
||
) |
Ejects the drive.
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. |
void Gio::Drive::eject | ( | const SlotAsyncReady & | slot, |
Mount::UnmountFlags | flags = Mount::UnmountFlags::NONE |
||
) |
Ejects the drive.
slot | A callback which will be called when the eject is completed. |
flags | Flags affecting the unmount if required for eject. |
void Gio::Drive::eject | ( | Mount::UnmountFlags | flags = Mount::UnmountFlags::NONE | ) |
Ejects the drive.
flags | Flags affecting the unmount if required for eject. |
bool Gio::Drive::eject_finish | ( | const Glib::RefPtr< AsyncResult > & | result | ) |
Finishes ejecting a drive.
If any errors occurred during the operation, error will be set to contain the errors and false
will be returned.
result | A AsyncResult. |
true
if the drive was successfully ejected. false
otherwise.Glib::Error |
std::vector< Glib::ustring > Gio::Drive::enumerate_identifiers | ( | ) | const |
Gets the kinds of identifiers that drive has.
Use g_drive_get_identifier() to obtain the identifiers themselves.
nullptr
-terminated array of strings containing kinds of identifiers. Glib::RefPtr< Icon > Gio::Drive::get_icon | ( | ) |
Gets the icon for drive.
Glib::RefPtr< const Icon > Gio::Drive::get_icon | ( | ) | const |
Gets the icon for drive.
std::string Gio::Drive::get_identifier | ( | const std::string & | kind | ) | const |
Gets the identifier of the given kind for drive.
The only identifier currently available is G_DRIVE_IDENTIFIER_KIND_UNIX_DEVICE.
kind | The kind of identifier to return. |
nullptr
if the Drive doesn't have this kind of identifier. Glib::ustring Gio::Drive::get_name | ( | ) | const |
Gets the name of drive.
Glib::ustring Gio::Drive::get_sort_key | ( | ) | const |
Gets the sort key for drive, if any.
nullptr
if no such key is available. StartStopType Gio::Drive::get_start_stop_type | ( | ) | const |
Gets a hint about how a drive can be started/stopped.
Glib::RefPtr< Icon > Gio::Drive::get_symbolic_icon | ( | ) |
Gets the icon for drive.
Glib::RefPtr< const Icon > Gio::Drive::get_symbolic_icon | ( | ) | const |
Gets the icon for drive.
Get the GType for this class, for use with the underlying GObject type system.
std::vector< Glib::RefPtr< Volume > > Gio::Drive::get_volumes | ( | ) |
Get a list of mountable volumes for drive.
|
inline |
Provides access to the underlying C GObject.
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.
true
if drive has media, false
otherwise. bool Gio::Drive::has_volumes | ( | ) | const |
Check if drive has any mountable volumes.
true
if the drive contains volumes, false
otherwise. bool Gio::Drive::is_media_check_automatic | ( | ) | const |
Checks if drive is capable of automatically detecting media changes.
true
if the drive is capable of automatically detecting media changes, false
otherwise. bool Gio::Drive::is_media_removable | ( | ) | const |
Checks if the drive supports removable media.
true
if drive supports removable media, false
otherwise. bool Gio::Drive::is_removable | ( | ) | const |
Checks if the Drive and/or its media is considered removable by the user.
See g_drive_is_media_removable().
true
if drive and/or its media is considered removable, false
otherwise. This is a default handler for the signal signal_changed().
This is a default handler for the signal signal_disconnected().
This is a default handler for the signal signal_eject_button().
This is a default handler for the signal signal_stop_button().
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.
slot | A callback which will be called when the poll is completed. |
void Gio::Drive::poll_for_media | ( | const SlotAsyncReady & | slot, |
const Glib::RefPtr< Cancellable > & | cancellable | ||
) |
Polls drive to see if media has been inserted or removed.
slot | A callback which will be called when the poll is completed. |
cancellable | A cancellable object which can be used to cancel the operation. |
bool Gio::Drive::poll_for_media_finish | ( | const Glib::RefPtr< AsyncResult > & | result | ) |
Finishes an operation started with g_drive_poll_for_media() on a drive.
result | A AsyncResult. |
true
if the drive has been poll_for_mediaed successfully, false
otherwise.Glib::Error |
Glib::SignalProxy< void()> Gio::Drive::signal_changed | ( | ) |
void on_my_changed()
Flags: Run Last
Emitted when the drive's state has changed.
Glib::SignalProxy< void()> Gio::Drive::signal_disconnected | ( | ) |
void on_my_disconnected()
Flags: Run Last
This signal is emitted when the Drive have been disconnected. If the recipient is holding references to the object they should release them so the object can be finalized.
Glib::SignalProxy< void()> Gio::Drive::signal_eject_button | ( | ) |
void on_my_eject_button()
Flags: Run Last
Emitted when the physical eject button (if any) of a drive has been pressed.
Glib::SignalProxy< void()> Gio::Drive::signal_stop_button | ( | ) |
void on_my_stop_button()
Flags: Run Last
Emitted when the physical stop button (if any) of a drive has been pressed.
void Gio::Drive::start | ( | const Glib::RefPtr< MountOperation > & | mount_operation, |
const Glib::RefPtr< Cancellable > & | cancellable, | ||
const SlotAsyncReady & | slot, | ||
StartFlags | flags = StartFlags::NONE |
||
) |
void Gio::Drive::start | ( | const Glib::RefPtr< MountOperation > & | mount_operation, |
const SlotAsyncReady & | slot, | ||
StartFlags | flags = StartFlags::NONE |
||
) |
bool Gio::Drive::start_finish | ( | const Glib::RefPtr< AsyncResult > & | result | ) |
Finishes starting a drive.
result | A AsyncResult. |
true
if the drive has been started successfully, false
otherwise.Glib::Error |
void Gio::Drive::stop | ( | const Glib::RefPtr< MountOperation > & | mount_operation, |
const Glib::RefPtr< Cancellable > & | cancellable, | ||
const SlotAsyncReady & | slot, | ||
Mount::UnmountFlags | flags = Mount::UnmountFlags::NONE |
||
) |
void Gio::Drive::stop | ( | const Glib::RefPtr< MountOperation > & | mount_operation, |
const SlotAsyncReady & | slot, | ||
Mount::UnmountFlags | flags = Mount::UnmountFlags::NONE |
||
) |
bool Gio::Drive::stop_finish | ( | const Glib::RefPtr< AsyncResult > & | result | ) |
Finishes stopping a drive.
result | A AsyncResult. |
true
if the drive has been stopped successfully, false
otherwise.Glib::Error |
|
related |
A Glib::wrap() method for this object.
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. |