1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>GFileMonitor</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GIO Reference Manual">
8 <link rel="up" href="file_mon.html" title="File System Monitoring">
9 <link rel="prev" href="file_mon.html" title="File System Monitoring">
10 <link rel="next" href="utils.html" title="File-related Utilities">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="file_mon.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="file_mon.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GIO Reference Manual</th>
21 <td><a accesskey="n" href="utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#GFileMonitor.synopsis" class="shortcut">Top</a>
26 <a href="#GFileMonitor.description" class="shortcut">Description</a>
28 <a href="#GFileMonitor.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#GFileMonitor.properties" class="shortcut">Properties</a>
32 <a href="#GFileMonitor.signals" class="shortcut">Signals</a>
35 <div class="refentry">
36 <a name="GFileMonitor"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
39 <h2><span class="refentrytitle"><a name="GFileMonitor.top_of_page"></a>GFileMonitor</span></h2>
40 <p>GFileMonitor — File Monitor</p>
42 <td valign="top" align="right"></td>
44 <div class="refsynopsisdiv">
45 <a name="GFileMonitor.synopsis"></a><h2>Synopsis</h2>
46 <pre class="synopsis">
47 #include <gio/gio.h>
49 enum <a class="link" href="GFileMonitor.html#GFileMonitorEvent" title="enum GFileMonitorEvent">GFileMonitorEvent</a>;
50 <a class="link" href="GFileMonitor.html#GFileMonitor-struct" title="GFileMonitor">GFileMonitor</a>;
51 <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GFileMonitor.html#g-file-monitor-cancel" title="g_file_monitor_cancel ()">g_file_monitor_cancel</a> (<em class="parameter"><code><a class="link" href="GFileMonitor.html" title="GFileMonitor"><span class="type">GFileMonitor</span></a> *monitor</code></em>);
52 <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GFileMonitor.html#g-file-monitor-is-cancelled" title="g_file_monitor_is_cancelled ()">g_file_monitor_is_cancelled</a> (<em class="parameter"><code><a class="link" href="GFileMonitor.html" title="GFileMonitor"><span class="type">GFileMonitor</span></a> *monitor</code></em>);
53 <span class="returnvalue">void</span> <a class="link" href="GFileMonitor.html#g-file-monitor-set-rate-limit" title="g_file_monitor_set_rate_limit ()">g_file_monitor_set_rate_limit</a> (<em class="parameter"><code><a class="link" href="GFileMonitor.html" title="GFileMonitor"><span class="type">GFileMonitor</span></a> *monitor</code></em>,
54 <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> limit_msecs</code></em>);
55 <span class="returnvalue">void</span> <a class="link" href="GFileMonitor.html#g-file-monitor-emit-event" title="g_file_monitor_emit_event ()">g_file_monitor_emit_event</a> (<em class="parameter"><code><a class="link" href="GFileMonitor.html" title="GFileMonitor"><span class="type">GFileMonitor</span></a> *monitor</code></em>,
56 <em class="parameter"><code><a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> *child</code></em>,
57 <em class="parameter"><code><a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> *other_file</code></em>,
58 <em class="parameter"><code><a class="link" href="GFileMonitor.html#GFileMonitorEvent" title="enum GFileMonitorEvent"><span class="type">GFileMonitorEvent</span></a> event_type</code></em>);
61 <div class="refsect1">
62 <a name="GFileMonitor.object-hierarchy"></a><h2>Object Hierarchy</h2>
63 <pre class="synopsis">
64 <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
68 <div class="refsect1">
69 <a name="GFileMonitor.properties"></a><h2>Properties</h2>
70 <pre class="synopsis">
71 "<a class="link" href="GFileMonitor.html#GFileMonitor--cancelled" title='The "cancelled" property'>cancelled</a>" <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read
72 "<a class="link" href="GFileMonitor.html#GFileMonitor--rate-limit" title='The "rate-limit" property'>rate-limit</a>" <a href="./../glib/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
75 <div class="refsect1">
76 <a name="GFileMonitor.signals"></a><h2>Signals</h2>
77 <pre class="synopsis">
78 "<a class="link" href="GFileMonitor.html#GFileMonitor-changed" title='The "changed" signal'>changed</a>" : <a href="./../gobject/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
81 <div class="refsect1">
82 <a name="GFileMonitor.description"></a><h2>Description</h2>
84 Monitors a file or directory for changes.
87 To obtain a <a class="link" href="GFileMonitor.html" title="GFileMonitor"><span class="type">GFileMonitor</span></a> for a file or directory, use
88 <a class="link" href="GFile.html#g-file-monitor" title="g_file_monitor ()"><code class="function">g_file_monitor()</code></a>, <a class="link" href="GFile.html#g-file-monitor-file" title="g_file_monitor_file ()"><code class="function">g_file_monitor_file()</code></a>, or
89 <a class="link" href="GFile.html#g-file-monitor-directory" title="g_file_monitor_directory ()"><code class="function">g_file_monitor_directory()</code></a>.
92 To get informed about changes to the file or directory you are
93 monitoring, connect to the <a class="link" href="GFileMonitor.html#GFileMonitor-changed" title='The "changed" signal'><span class="type">"changed"</span></a> signal. The
94 signal will be emitted in the <GTKDOCLINK HREF="g-main-context-push-thread-default">thread-default main
95 context</GTKDOCLINK> of the thread that the monitor was created in
96 (though if the global default main context is blocked, this may
97 cause notifications to be blocked even if the thread-default
98 context is still running).
101 <div class="refsect1">
102 <a name="GFileMonitor.details"></a><h2>Details</h2>
103 <div class="refsect2">
104 <a name="GFileMonitorEvent"></a><h3>enum GFileMonitorEvent</h3>
105 <pre class="programlisting">typedef enum {
106 G_FILE_MONITOR_EVENT_CHANGED,
107 G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT,
108 G_FILE_MONITOR_EVENT_DELETED,
109 G_FILE_MONITOR_EVENT_CREATED,
110 G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED,
111 G_FILE_MONITOR_EVENT_PRE_UNMOUNT,
112 G_FILE_MONITOR_EVENT_UNMOUNTED,
113 G_FILE_MONITOR_EVENT_MOVED
117 Specifies what type of event a monitor event is.
119 <div class="variablelist"><table border="0">
120 <col align="left" valign="top">
123 <td><p><a name="G-FILE-MONITOR-EVENT-CHANGED:CAPS"></a><span class="term"><code class="literal">G_FILE_MONITOR_EVENT_CHANGED</code></span></p></td>
128 <td><p><a name="G-FILE-MONITOR-EVENT-CHANGES-DONE-HINT:CAPS"></a><span class="term"><code class="literal">G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT</code></span></p></td>
129 <td>a hint that this was probably the last change in a set of changes.
133 <td><p><a name="G-FILE-MONITOR-EVENT-DELETED:CAPS"></a><span class="term"><code class="literal">G_FILE_MONITOR_EVENT_DELETED</code></span></p></td>
134 <td>a file was deleted.
138 <td><p><a name="G-FILE-MONITOR-EVENT-CREATED:CAPS"></a><span class="term"><code class="literal">G_FILE_MONITOR_EVENT_CREATED</code></span></p></td>
139 <td>a file was created.
143 <td><p><a name="G-FILE-MONITOR-EVENT-ATTRIBUTE-CHANGED:CAPS"></a><span class="term"><code class="literal">G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED</code></span></p></td>
144 <td>a file attribute was changed.
148 <td><p><a name="G-FILE-MONITOR-EVENT-PRE-UNMOUNT:CAPS"></a><span class="term"><code class="literal">G_FILE_MONITOR_EVENT_PRE_UNMOUNT</code></span></p></td>
149 <td>the file location will soon be unmounted.
153 <td><p><a name="G-FILE-MONITOR-EVENT-UNMOUNTED:CAPS"></a><span class="term"><code class="literal">G_FILE_MONITOR_EVENT_UNMOUNTED</code></span></p></td>
154 <td>the file location was unmounted.
158 <td><p><a name="G-FILE-MONITOR-EVENT-MOVED:CAPS"></a><span class="term"><code class="literal">G_FILE_MONITOR_EVENT_MOVED</code></span></p></td>
159 <td>the file was moved.
166 <div class="refsect2">
167 <a name="GFileMonitor-struct"></a><h3>GFileMonitor</h3>
168 <pre class="programlisting">typedef struct _GFileMonitor GFileMonitor;</pre>
170 Watches for changes to a file.
174 <div class="refsect2">
175 <a name="g-file-monitor-cancel"></a><h3>g_file_monitor_cancel ()</h3>
176 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> g_file_monitor_cancel (<em class="parameter"><code><a class="link" href="GFileMonitor.html" title="GFileMonitor"><span class="type">GFileMonitor</span></a> *monitor</code></em>);</pre>
178 Cancels a file monitor.
180 <div class="variablelist"><table border="0">
181 <col align="left" valign="top">
184 <td><p><span class="term"><em class="parameter"><code>monitor</code></em> :</span></p></td>
185 <td>a <a class="link" href="GFileMonitor.html" title="GFileMonitor"><span class="type">GFileMonitor</span></a>.</td>
188 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
190 <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if monitor was cancelled.</td>
196 <div class="refsect2">
197 <a name="g-file-monitor-is-cancelled"></a><h3>g_file_monitor_is_cancelled ()</h3>
198 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> g_file_monitor_is_cancelled (<em class="parameter"><code><a class="link" href="GFileMonitor.html" title="GFileMonitor"><span class="type">GFileMonitor</span></a> *monitor</code></em>);</pre>
200 Returns whether the monitor is canceled.
202 <div class="variablelist"><table border="0">
203 <col align="left" valign="top">
206 <td><p><span class="term"><em class="parameter"><code>monitor</code></em> :</span></p></td>
207 <td>a <a class="link" href="GFileMonitor.html" title="GFileMonitor"><span class="type">GFileMonitor</span></a>
211 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
213 <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if monitor is canceled. <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
219 <div class="refsect2">
220 <a name="g-file-monitor-set-rate-limit"></a><h3>g_file_monitor_set_rate_limit ()</h3>
221 <pre class="programlisting"><span class="returnvalue">void</span> g_file_monitor_set_rate_limit (<em class="parameter"><code><a class="link" href="GFileMonitor.html" title="GFileMonitor"><span class="type">GFileMonitor</span></a> *monitor</code></em>,
222 <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> limit_msecs</code></em>);</pre>
224 Sets the rate limit to which the <em class="parameter"><code>monitor</code></em> will report
225 consecutive change events to the same file.
227 <div class="variablelist"><table border="0">
228 <col align="left" valign="top">
231 <td><p><span class="term"><em class="parameter"><code>monitor</code></em> :</span></p></td>
232 <td>a <a class="link" href="GFileMonitor.html" title="GFileMonitor"><span class="type">GFileMonitor</span></a>.</td>
235 <td><p><span class="term"><em class="parameter"><code>limit_msecs</code></em> :</span></p></td>
236 <td>a non-negative integer with the limit in milliseconds
237 to poll for changes</td>
243 <div class="refsect2">
244 <a name="g-file-monitor-emit-event"></a><h3>g_file_monitor_emit_event ()</h3>
245 <pre class="programlisting"><span class="returnvalue">void</span> g_file_monitor_emit_event (<em class="parameter"><code><a class="link" href="GFileMonitor.html" title="GFileMonitor"><span class="type">GFileMonitor</span></a> *monitor</code></em>,
246 <em class="parameter"><code><a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> *child</code></em>,
247 <em class="parameter"><code><a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> *other_file</code></em>,
248 <em class="parameter"><code><a class="link" href="GFileMonitor.html#GFileMonitorEvent" title="enum GFileMonitorEvent"><span class="type">GFileMonitorEvent</span></a> event_type</code></em>);</pre>
250 Emits the <a class="link" href="GFileMonitor.html#GFileMonitor-changed" title='The "changed" signal'><span class="type">"changed"</span></a> signal if a change
251 has taken place. Should be called from file monitor
252 implementations only.
255 The signal will be emitted from an idle handler (in the <GTKDOCLINK HREF="g-main-context-push-thread-default">thread-default main
256 context</GTKDOCLINK>).
258 <div class="variablelist"><table border="0">
259 <col align="left" valign="top">
262 <td><p><span class="term"><em class="parameter"><code>monitor</code></em> :</span></p></td>
263 <td>a <a class="link" href="GFileMonitor.html" title="GFileMonitor"><span class="type">GFileMonitor</span></a>.</td>
266 <td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
267 <td>a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a>.</td>
270 <td><p><span class="term"><em class="parameter"><code>other_file</code></em> :</span></p></td>
271 <td>a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a>.</td>
274 <td><p><span class="term"><em class="parameter"><code>event_type</code></em> :</span></p></td>
275 <td>a set of <a class="link" href="GFileMonitor.html#GFileMonitorEvent" title="enum GFileMonitorEvent"><span class="type">GFileMonitorEvent</span></a> flags.</td>
281 <div class="refsect1">
282 <a name="GFileMonitor.property-details"></a><h2>Property Details</h2>
283 <div class="refsect2">
284 <a name="GFileMonitor--cancelled"></a><h3>The <code class="literal">"cancelled"</code> property</h3>
285 <pre class="programlisting"> "cancelled" <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre>
286 <p>Whether the monitor has been cancelled.</p>
287 <p>Default value: FALSE</p>
290 <div class="refsect2">
291 <a name="GFileMonitor--rate-limit"></a><h3>The <code class="literal">"rate-limit"</code> property</h3>
292 <pre class="programlisting"> "rate-limit" <a href="./../glib/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
293 <p>The limit of the monitor to watch for changes, in milliseconds.</p>
294 <p>Allowed values: >= 0</p>
295 <p>Default value: 800</p>
298 <div class="refsect1">
299 <a name="GFileMonitor.signal-details"></a><h2>Signal Details</h2>
300 <div class="refsect2">
301 <a name="GFileMonitor-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>
302 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GFileMonitor.html" title="GFileMonitor"><span class="type">GFileMonitor</span></a> *monitor,
303 <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> *file,
304 <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> *other_file,
305 <a class="link" href="GFileMonitor.html#GFileMonitorEvent" title="enum GFileMonitorEvent"><span class="type">GFileMonitorEvent</span></a> event_type,
306 <a href="./../glib/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="./../gobject/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
308 Emitted when <em class="parameter"><code>file</code></em> has been changed.
311 If using <a class="link" href="GFile.html#G-FILE-MONITOR-SEND-MOVED:CAPS"><span class="type">G_FILE_MONITOR_SEND_MOVED</span></a> flag and <em class="parameter"><code>event_type</code></em> is
312 <a class="link" href="GFileMonitor.html#G-FILE-MONITOR-EVENT-MOVED:CAPS"><span class="type">G_FILE_MONITOR_EVENT_MOVED</span></a>, <em class="parameter"><code>file</code></em> will be set to a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> containing the
313 old path, and <em class="parameter"><code>other_file</code></em> will be set to a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> containing the new path.
316 In all the other cases, <em class="parameter"><code>other_file</code></em> will be set to <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>.
318 <div class="variablelist"><table border="0">
319 <col align="left" valign="top">
322 <td><p><span class="term"><em class="parameter"><code>monitor</code></em> :</span></p></td>
323 <td>a <a class="link" href="GFileMonitor.html" title="GFileMonitor"><span class="type">GFileMonitor</span></a>.</td>
326 <td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
327 <td>a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a>.</td>
330 <td><p><span class="term"><em class="parameter"><code>other_file</code></em> :</span></p></td>
331 <td>a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
335 <td><p><span class="term"><em class="parameter"><code>event_type</code></em> :</span></p></td>
336 <td>a <a class="link" href="GFileMonitor.html#GFileMonitorEvent" title="enum GFileMonitorEvent"><span class="type">GFileMonitorEvent</span></a>.</td>
339 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
340 <td>user data set when the signal handler was connected.</td>
349 Generated by GTK-Doc V1.18</div>