glibmm: Gio::FileMonitor Class Reference

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

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

Inheritance diagram for Gio::FileMonitor:

Public Types

- 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
 

Public Member Functions

 FileMonitor (FileMonitor&& src) noexcept
 
FileMonitoroperator= (FileMonitor&& src) noexcept
 
 ~FileMonitor () noexcept override
 
GFileMonitor* gobj ()
 Provides access to the underlying C GObject. More...

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

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

 
bool cancel ()
 Cancels a file monitor. More...

 
bool is_cancelled () const
 Returns whether the monitor is canceled. More...

 
void set_rate_limit (int limit_msecs)
 Sets the rate limit to which the monitor will report consecutive change events to the same file. More...

 
Glib::SignalProxy< void(const Glib::RefPtr< File >&, const Glib::RefPtr< File >&, Event)> signal_changed ()
 
Glib::PropertyProxy< int > property_rate_limit ()
 The limit of the monitor to watch for changes, in milliseconds. More...

 
Glib::PropertyProxy_ReadOnly< int > property_rate_limit () const
 The limit of the monitor to watch for changes, in milliseconds. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_cancelled () const
 Whether the monitor has been cancelled. More...

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

 

Protected Member Functions

virtual void on_changed (const Glib::RefPtr< File >& file, const Glib::RefPtr< File >& other_file, Event event_type)
 This is a default handler for the signal signal_changed(). 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::FileMonitorwrap (GFileMonitor* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...

 

Detailed Description

Monitors a file or directory for changes.

To obtain a FileMonitor for a file or directory, use File::monitor_file() or File::monitor_directory().

To get informed about changes to the file or directory you are monitoring, connect to signal_changed().

Since glibmm 2.16:

Constructor & Destructor Documentation

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

Member Function Documentation

bool Gio::FileMonitor::cancel ( )

Cancels a file monitor.

Returns
Always true.
static GType Gio::FileMonitor::get_type ( )
static

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

GFileMonitor* Gio::FileMonitor::gobj ( )
inline

Provides access to the underlying C GObject.

const GFileMonitor* Gio::FileMonitor::gobj ( ) const
inline

Provides access to the underlying C GObject.

GFileMonitor* Gio::FileMonitor::gobj_copy ( )

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

bool Gio::FileMonitor::is_cancelled ( ) const

Returns whether the monitor is canceled.

Returns
true if monitor is canceled. false otherwise.
virtual void Gio::FileMonitor::on_changed ( const Glib::RefPtr< File >&  file,
const Glib::RefPtr< File >&  other_file,
Event  event_type 
)
protectedvirtual

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

FileMonitor& Gio::FileMonitor::operator= ( FileMonitor&&  src)
noexcept
Glib::PropertyProxy_ReadOnly< bool > Gio::FileMonitor::property_cancelled ( ) const

Whether the monitor has been cancelled.

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gio::FileMonitor::property_rate_limit ( )

The limit of the monitor to watch for changes, in milliseconds.

Default value: 800

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gio::FileMonitor::property_rate_limit ( ) const

The limit of the monitor to watch for changes, in milliseconds.

Default value: 800

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gio::FileMonitor::set_rate_limit ( int  limit_msecs)

Sets the rate limit to which the monitor will report consecutive change events to the same file.

Parameters
limit_msecsA non-negative integer with the limit in milliseconds to poll for changes.
Glib::SignalProxy<void(const Glib::RefPtr<File>&, const Glib::RefPtr<File>&, Event)> Gio::FileMonitor::signal_changed ( )
Slot Prototype:
void on_my_changed(const Glib::RefPtr<File>& file, const Glib::RefPtr<File>& other_file, Event event_type)

Flags: Run Last

Emitted when file has been changed.

If using Gio::FileMonitorFlags::WATCH_MOVES on a directory monitor, and the information is available (and if supported by the backend), event_type may be Gio::FileMonitor::Event::RENAMED, Gio::FileMonitor::Event::MOVED_IN or Gio::FileMonitor::Event::MOVED_OUT.

In all cases file will be a child of the monitored directory. For renames, file will be the old name and other_file is the new name. For "moved in" events, file is the name of the file that appeared and other_file is the old name that it was moved from (in another directory). For "moved out" events, file is the name of the file that used to be in this directory and other_file is the name of the file at its new location.

It makes sense to treat Gio::FileMonitor::Event::MOVED_IN as equivalent to Gio::FileMonitor::Event::CREATED and Gio::FileMonitor::Event::MOVED_OUT as equivalent to Gio::FileMonitor::Event::DELETED, with extra information. Gio::FileMonitor::Event::RENAMED is equivalent to a delete/create pair. This is exactly how the events will be reported in the case that the Gio::FileMonitorFlags::WATCH_MOVES flag is not in use.

If using the deprecated flag Gio::FileMonitorFlags::SEND_MOVED flag and event_type is Gio::FileMonitor::Event::MOVED, file will be set to a File containing the old path, and other_file will be set to a File containing the new path.

In all the other cases, other_file will be set to #nullptr.

Parameters
fileA File.
other_fileA File or #nullptr.
event_typeA Gio::FileMonitor::Event.

Friends And Related Function Documentation

Glib::RefPtr< Gio::FileMonitor > wrap ( GFileMonitor *  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.