| Top |  |
 |
 |
 |
Properties
| gboolean | cancelled | Read |
| GMainContext * | context | Write / Construct Only |
| gint | rate-limit | Read / Write |
Description
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. The signal will be emitted in the thread-default main context of the thread that the monitor was created in (though if the global default main context is blocked, this may cause notifications to be blocked even if the thread-default context is still running).
Functions
g_file_monitor_cancel ()
gboolean
g_file_monitor_cancel (GFileMonitor *monitor);
Cancels a file monitor.
g_file_monitor_is_cancelled ()
gboolean
g_file_monitor_is_cancelled (GFileMonitor *monitor);
Returns whether the monitor is canceled.
g_file_monitor_set_rate_limit ()
void g_file_monitor_set_rate_limit (GFileMonitor *monitor,gint limit_msecs);
Sets the rate limit to which the monitor
will report
consecutive change events to the same file.
Parameters
monitor |
a GFileMonitor. |
|
limit_msecs |
a non-negative integer with the limit in milliseconds to poll for changes |
g_file_monitor_emit_event ()
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 (in the thread-default main context).
Parameters
monitor |
a GFileMonitor. |
|
child |
a GFile. |
|
other_file |
a GFile. |
|
event_type |
a set of GFileMonitorEvent flags. |
Types and Values
enum GFileMonitorEvent
Specifies what type of event a monitor event is.
Property Details
The “cancelled” property
“cancelled” gboolean
Whether the monitor has been cancelled.
Flags: Read
Default value: FALSE
The “context” property
“context” GMainContext *
The main context to dispatch from.
Flags: Write / Construct Only
The “rate-limit” property
“rate-limit” gint
The limit of the monitor to watch for changes, in milliseconds.
Flags: Read / Write
Allowed values: >= 0
Default value: 800
Signal Details
The “changed” signal
void user_function (GFileMonitor *monitor, GFile *file, GFile *other_file, GFileMonitorEvent event_type, gpointer user_data)
Emitted when file
has been changed.
If using G_FILE_MONITOR_SEND_MOVED flag and event_type
is
G_FILE_MONITOR_EVENT_MOVED, file
will be set to a GFile containing the
old path, and other_file
will be set to a GFile containing the new path.
In all the other cases, other_file
will be set to NULL.
Parameters
monitor |
a GFileMonitor. |
|
file |
a GFile. |
|
other_file |
[allow-none] | |
event_type |
||
user_data |
user data set when the signal handler was connected. |
Flags: Run Last