glibmm: Gio::VolumeMonitor Class Reference

Monitors a file or directory for changes. More...

#include </home/kjell/checkout/gnome/glibmm/gio/giomm/volumemonitor.h>

Inheritance diagram for Gio::VolumeMonitor:

Public Member Functions

 VolumeMonitor (VolumeMonitor&& src) noexcept
 
VolumeMonitoroperator= (VolumeMonitor&& src) noexcept
 
 ~VolumeMonitor () noexcept override
 
GVolumeMonitor* gobj ()
 Provides access to the underlying C GObject. More...

 
const GVolumeMonitor* gobj () const
 Provides access to the underlying C GObject. More...

 
GVolumeMonitor* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

 
std::vector< Glib::RefPtr< Drive > > get_connected_drives ()
 Gets a list of drives connected to the system. More...

 
std::vector< Glib::RefPtr< Volume > > get_volumes ()
 Gets a list of the volumes on the system. More...

 
std::vector< Glib::RefPtr< Mount > > get_mounts ()
 Gets a list of the mounts on the system. More...

 
Glib::RefPtr< Volumeget_volume_for_uuid (const std::string& uuid)
 Finds a Volume object by its UUID (see g_volume_get_uuid()) More...

 
Glib::RefPtr< Mountget_mount_for_uuid (const std::string& uuid)
 Finds a Mount object by its UUID (see g_mount_get_uuid()) More...

 
Glib::SignalProxy< void(const Glib::RefPtr< Volume >&)> signal_volume_added ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Volume >&)> signal_volume_removed ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Volume >&)> signal_volume_changed ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Mount >&)> signal_mount_added ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Mount >&)> signal_mount_removed ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Mount >&)> signal_mount_pre_unmount ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Mount >&)> signal_mount_changed ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Drive >&)> signal_drive_connected ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Drive >&)> signal_drive_disconnected ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Drive >&)> signal_drive_changed ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Drive >&)> signal_drive_eject_button ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Drive >&)> signal_drive_stop_button ()
 
- Public Member Functions inherited from Glib::Object
 Object (const Object&)=delete
 
Objectoperator= (const Object&)=delete
 
 Object (Object&& src) noexcept
 
Objectoperator= (Object&& src) noexcept
 
void* get_data (const QueryQuark& key)
 
void set_data (const Quark& key, void* data)
 
void set_data (const Quark& key, void* data, DestroyNotify notify)
 
void remove_data (const QueryQuark& quark)
 
void* steal_data (const QueryQuark& quark)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase&)=delete
 
ObjectBaseoperator= (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. More...

 
void get_property_value (const Glib::ustring& property_name, Glib::ValueBase& value) const
 You probably want to use a specific property_*() accessor method instead. More...

 
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. More...

 
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. More...

 
template<class PropertyType >
PropertyType get_property (const Glib::ustring& property_name) const
 You probably want to use a specific property_*() accessor method instead. More...

 
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. More...

 
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. More...

 
void freeze_notify ()
 Increases the freeze count on object. More...

 
void thaw_notify ()
 Reverts the effect of a previous call to freeze_notify(). More...

 
virtual void reference () const
 Increment the reference count for this object. More...

 
virtual void unreference () const
 Decrement the reference count for this object. More...

 
GObject* gobj ()
 Provides access to the underlying C GObject. More...

 
const GObject* gobj () const
 Provides access to the underlying C GObject. More...

 
GObject* gobj_copy () const
 Give a ref-ed copy to someone. Use for direct struct access. More...

 
- Public Member Functions inherited from sigc::trackable
 trackable () noexcept
 
 trackable (const trackable &src) noexcept
 
 trackable (trackable &&src) noexcept
 
 ~trackable ()
 
void add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src) noexcept
 
void remove_destroy_notify_callback (notifiable *data) const
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
static Glib::RefPtr< VolumeMonitorget ()
 Gets the volume monitor used by gio. More...

 

Protected Member Functions

virtual void on_volume_added (const Glib::RefPtr< Volume >& volume)
 This is a default handler for the signal signal_volume_added(). More...

 
virtual void on_volume_removed (const Glib::RefPtr< Volume >& volume)
 This is a default handler for the signal signal_volume_removed(). More...

 
virtual void on_volume_changed (const Glib::RefPtr< Volume >& volume)
 This is a default handler for the signal signal_volume_changed(). More...

 
virtual void on_mount_added (const Glib::RefPtr< Mount >& mount)
 This is a default handler for the signal signal_mount_added(). More...

 
virtual void on_mount_removed (const Glib::RefPtr< Mount >& mount)
 This is a default handler for the signal signal_mount_removed(). More...

 
virtual void on_mount_pre_unmount (const Glib::RefPtr< Mount >& mount)
 This is a default handler for the signal signal_mount_pre_unmount(). More...

 
virtual void on_mount_changed (const Glib::RefPtr< Mount >& mount)
 This is a default handler for the signal signal_mount_changed(). More...

 
virtual void on_drive_connected (const Glib::RefPtr< Drive >& drive)
 This is a default handler for the signal signal_drive_connected(). More...

 
virtual void on_drive_disconnected (const Glib::RefPtr< Drive >& drive)
 This is a default handler for the signal signal_drive_disconnected(). More...

 
virtual void on_drive_changed (const Glib::RefPtr< Drive >& drive)
 This is a default handler for the signal signal_drive_changed(). More...

 
virtual void on_drive_eject_button (const Glib::RefPtr< Drive >& drive)
 This is a default handler for the signal signal_drive_eject_button(). More...

 
virtual void on_drive_stop_button (const Glib::RefPtr< Drive >& drive)
 This is a default handler for the signal signal_drive_stop_button(). More...

 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams& construct_params)
 
 Object (GObject* castitem)
 
 ~Object () noexcept override
 
- 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. More...

 
 ObjectBase (const char* custom_type_name)
 A derived constructor always overrides this choice. More...

 
 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. More...

 
 ObjectBase (ObjectBase&& src) noexcept
 
ObjectBaseoperator= (ObjectBase&& src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject* castitem)
 
void initialize_move (GObject* castitem, Glib::ObjectBase* previous_wrapper)
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gio::VolumeMonitorwrap (GVolumeMonitor* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...

 

Additional Inherited Members

- Public Types inherited from Glib::Object
using DestroyNotify = void(*)(gpointer data)
 
- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
 
- Public Types inherited from sigc::notifiable
typedef internal::func_destroy_notify func_destroy_notify
 

Detailed Description

Monitors a file or directory for changes.

VolumeMonitor is for listing the user-interesting devices and volumes on the computer. In other words, what a file selector or file manager would show in a sidebar.

Since glibmm 2.16:

Constructor & Destructor Documentation

Gio::VolumeMonitor::VolumeMonitor ( VolumeMonitor&&  src)
noexcept
Gio::VolumeMonitor::~VolumeMonitor ( )
overridenoexcept

Member Function Documentation

static Glib::RefPtr<VolumeMonitor> Gio::VolumeMonitor::get ( )
static

Gets the volume monitor used by gio.

Returns
A reference to the VolumeMonitor used by gio. Call Glib::object_unref() when done with it.
std::vector<Glib::RefPtr<Drive> > Gio::VolumeMonitor::get_connected_drives ( )

Gets a list of drives connected to the system.

Returns
A List of connected Drive objects.
Glib::RefPtr<Mount> Gio::VolumeMonitor::get_mount_for_uuid ( const std::string uuid)

Finds a Mount object by its UUID (see g_mount_get_uuid())

Parameters
uuidThe UUID to look for.
Returns
A Mount or nullptr if no such mount is available. Free the returned object with Glib::object_unref().
std::vector<Glib::RefPtr<Mount> > Gio::VolumeMonitor::get_mounts ( )

Gets a list of the mounts on the system.

Returns
A List of Mount objects.
static GType Gio::VolumeMonitor::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

Glib::RefPtr<Volume> Gio::VolumeMonitor::get_volume_for_uuid ( const std::string uuid)

Finds a Volume object by its UUID (see g_volume_get_uuid())

Parameters
uuidThe UUID to look for.
Returns
A Volume or nullptr if no such volume is available. Free the returned object with Glib::object_unref().
std::vector<Glib::RefPtr<Volume> > Gio::VolumeMonitor::get_volumes ( )

Gets a list of the volumes on the system.

Returns
A List of Volume objects.
GVolumeMonitor* Gio::VolumeMonitor::gobj ( )
inline

Provides access to the underlying C GObject.

const GVolumeMonitor* Gio::VolumeMonitor::gobj ( ) const
inline

Provides access to the underlying C GObject.

GVolumeMonitor* Gio::VolumeMonitor::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

virtual void Gio::VolumeMonitor::on_drive_changed ( const Glib::RefPtr< Drive >&  drive)
protectedvirtual

This is a default handler for the signal signal_drive_changed().

virtual void Gio::VolumeMonitor::on_drive_connected ( const Glib::RefPtr< Drive >&  drive)
protectedvirtual

This is a default handler for the signal signal_drive_connected().

virtual void Gio::VolumeMonitor::on_drive_disconnected ( const Glib::RefPtr< Drive >&  drive)
protectedvirtual

This is a default handler for the signal signal_drive_disconnected().

virtual void Gio::VolumeMonitor::on_drive_eject_button ( const Glib::RefPtr< Drive >&  drive)
protectedvirtual

This is a default handler for the signal signal_drive_eject_button().

virtual void Gio::VolumeMonitor::on_drive_stop_button ( const Glib::RefPtr< Drive >&  drive)
protectedvirtual

This is a default handler for the signal signal_drive_stop_button().

virtual void Gio::VolumeMonitor::on_mount_added ( const Glib::RefPtr< Mount >&  mount)
protectedvirtual

This is a default handler for the signal signal_mount_added().

virtual void Gio::VolumeMonitor::on_mount_changed ( const Glib::RefPtr< Mount >&  mount)
protectedvirtual

This is a default handler for the signal signal_mount_changed().

virtual void Gio::VolumeMonitor::on_mount_pre_unmount ( const Glib::RefPtr< Mount >&  mount)
protectedvirtual

This is a default handler for the signal signal_mount_pre_unmount().

virtual void Gio::VolumeMonitor::on_mount_removed ( const Glib::RefPtr< Mount >&  mount)
protectedvirtual

This is a default handler for the signal signal_mount_removed().

virtual void Gio::VolumeMonitor::on_volume_added ( const Glib::RefPtr< Volume >&  volume)
protectedvirtual

This is a default handler for the signal signal_volume_added().

virtual void Gio::VolumeMonitor::on_volume_changed ( const Glib::RefPtr< Volume >&  volume)
protectedvirtual

This is a default handler for the signal signal_volume_changed().

virtual void Gio::VolumeMonitor::on_volume_removed ( const Glib::RefPtr< Volume >&  volume)
protectedvirtual

This is a default handler for the signal signal_volume_removed().

VolumeMonitor& Gio::VolumeMonitor::operator= ( VolumeMonitor&&  src)
noexcept
Glib::SignalProxy<void(const Glib::RefPtr<Drive>&)> Gio::VolumeMonitor::signal_drive_changed ( )
Slot Prototype:
void on_my_drive_changed(const Glib::RefPtr<Drive>& drive)

Flags: Run Last

Emitted when a drive changes.

Parameters
driveThe drive that changed.
Glib::SignalProxy<void(const Glib::RefPtr<Drive>&)> Gio::VolumeMonitor::signal_drive_connected ( )
Slot Prototype:
void on_my_drive_connected(const Glib::RefPtr<Drive>& drive)

Flags: Run Last

Emitted when a drive is connected to the system.

Parameters
driveA Drive that was connected.
Glib::SignalProxy<void(const Glib::RefPtr<Drive>&)> Gio::VolumeMonitor::signal_drive_disconnected ( )
Slot Prototype:
void on_my_drive_disconnected(const Glib::RefPtr<Drive>& drive)

Flags: Run Last

Emitted when a drive is disconnected from the system.

Parameters
driveA Drive that was disconnected.
Glib::SignalProxy<void(const Glib::RefPtr<Drive>&)> Gio::VolumeMonitor::signal_drive_eject_button ( )
Slot Prototype:
void on_my_drive_eject_button(const Glib::RefPtr<Drive>& drive)

Flags: Run Last

Emitted when the eject button is pressed on drive.

Since glibmm 2.18:
Parameters
driveThe drive where the eject button was pressed.
Glib::SignalProxy<void(const Glib::RefPtr<Drive>&)> Gio::VolumeMonitor::signal_drive_stop_button ( )
Slot Prototype:
void on_my_drive_stop_button(const Glib::RefPtr<Drive>& drive)

Flags: Run Last

Emitted when the stop button is pressed on drive.

Since glibmm 2.22:
Parameters
driveThe drive where the stop button was pressed.
Glib::SignalProxy<void(const Glib::RefPtr<Mount>&)> Gio::VolumeMonitor::signal_mount_added ( )
Slot Prototype:
void on_my_mount_added(const Glib::RefPtr<Mount>& mount)

Flags: Run Last

Emitted when a mount is added.

Parameters
mountA Mount that was added.
Glib::SignalProxy<void(const Glib::RefPtr<Mount>&)> Gio::VolumeMonitor::signal_mount_changed ( )
Slot Prototype:
void on_my_mount_changed(const Glib::RefPtr<Mount>& mount)

Flags: Run Last

Emitted when a mount changes.

Parameters
mountA Mount that changed.
Glib::SignalProxy<void(const Glib::RefPtr<Mount>&)> Gio::VolumeMonitor::signal_mount_pre_unmount ( )
Slot Prototype:
void on_my_mount_pre_unmount(const Glib::RefPtr<Mount>& mount)

Flags: Run Last

May be emitted when a mount is about to be removed.

This signal depends on the backend and is only emitted if GIO was used to unmount.

Parameters
mountA Mount that is being unmounted.
Glib::SignalProxy<void(const Glib::RefPtr<Mount>&)> Gio::VolumeMonitor::signal_mount_removed ( )
Slot Prototype:
void on_my_mount_removed(const Glib::RefPtr<Mount>& mount)

Flags: Run Last

Emitted when a mount is removed.

Parameters
mountA Mount that was removed.
Glib::SignalProxy<void(const Glib::RefPtr<Volume>&)> Gio::VolumeMonitor::signal_volume_added ( )
Slot Prototype:
void on_my_volume_added(const Glib::RefPtr<Volume>& volume)

Flags: Run Last

Emitted when a mountable volume is added to the system.

Parameters
volumeA Volume that was added.
Glib::SignalProxy<void(const Glib::RefPtr<Volume>&)> Gio::VolumeMonitor::signal_volume_changed ( )
Slot Prototype:
void on_my_volume_changed(const Glib::RefPtr<Volume>& volume)

Flags: Run Last

Emitted when mountable volume is changed.

Parameters
volumeA Volume that changed.
Glib::SignalProxy<void(const Glib::RefPtr<Volume>&)> Gio::VolumeMonitor::signal_volume_removed ( )
Slot Prototype:
void on_my_volume_removed(const Glib::RefPtr<Volume>& volume)

Flags: Run Last

Emitted when a mountable volume is removed from the system.

Parameters
volumeA Volume that was removed.

Friends And Related Function Documentation

Glib::RefPtr< Gio::VolumeMonitor > wrap ( GVolumeMonitor *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse 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.