|
|
|
GIO Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | Signals | ||||
#include <gio/gio.h> enum GFileMonitorEvent; GFileMonitor; gboolean g_file_monitor_cancel (GFileMonitor *monitor); gboolean g_file_monitor_is_cancelled (GFileMonitor *monitor); void g_file_monitor_set_rate_limit (GFileMonitor *monitor, int limit_msecs); void g_file_monitor_emit_event (GFileMonitor *monitor, GFile *child, GFile *other_file, GFileMonitorEvent event_type);
Monitors a file or directory for changes.
To obtain a GFileMonitor for a file or directory, use
g_file_monitor(), g_file_monitor_file(), or
g_file_monitor_directory().
To get informed about changes to the file or directory you are monitoring, connect to the "changed" signal.
typedef enum {
G_FILE_MONITOR_EVENT_CHANGED,
G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT,
G_FILE_MONITOR_EVENT_DELETED,
G_FILE_MONITOR_EVENT_CREATED,
G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED,
G_FILE_MONITOR_EVENT_PRE_UNMOUNT,
G_FILE_MONITOR_EVENT_UNMOUNTED
} GFileMonitorEvent;
Specifies what type of event a monitor event is.
| a file changed. | |
| a hint that this was probably the last change in a set of changes. | |
| a file was deleted. | |
| a file was created. | |
| a file attribute was changed. | |
| the file location will soon be unmounted. | |
| the file location was unmounted. |
gboolean g_file_monitor_cancel (GFileMonitor *monitor);
Cancels a file monitor.
|
a GFileMonitor. |
Returns : |
TRUE if monitor was cancelled.
|
gboolean g_file_monitor_is_cancelled (GFileMonitor *monitor);
Returns whether the monitor is canceled.
|
a GFileMonitor |
Returns : |
TRUE if monitor is canceled. FALSE otherwise.
|
void g_file_monitor_set_rate_limit (GFileMonitor *monitor, int limit_msecs);
Sets the rate limit to which the monitor will report
consecutive change events to the same file.
|
a GFileMonitor. |
|
a integer with the limit in milliseconds to poll for changes. |
void g_file_monitor_emit_event (GFileMonitor *monitor, GFile *child, GFile *other_file, GFileMonitorEvent event_type);
Emits the "changed" signal if a change has taken place. Should be called from file monitor implementations only.
The signal will be emitted from an idle handler.
|
a GFileMonitor. |
|
a GFile. |
|
a GFile. |
|
a set of GFileMonitorEvent flags. |
"cancelled" property"cancelled" gboolean : Read
Whether the monitor has been cancelled.
Default value: FALSE
"rate-limit" property"rate-limit" gint : Read / Write
The limit of the monitor to watch for changes, in milliseconds.
Allowed values: >= 0
Default value: 800
"changed" signalvoid user_function (GFileMonitor *monitor, GFile *file, GFile *other_file, GFileMonitorEvent event_type, gpointer user_data) : Run Last
Emitted when a file has been changed.
|
a GFileMonitor. |
|
a GFile. |
|
a GFile. |
|
a GFileMonitorEvent. |
|
user data set when the signal handler was connected. |