Imported Upstream version 2.50.2
[platform/upstream/glib.git] / docs / reference / gio / html / GFileMonitor.html
index 974876d..c478766 100644 (file)
@@ -8,7 +8,7 @@
 <link rel="up" href="file_mon.html" title="File System Monitoring">
 <link rel="prev" href="file_mon.html" title="File System Monitoring">
 <link rel="next" href="utils.html" title="File-related Utilities">
-<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -44,7 +44,7 @@
 <tbody>
 <tr>
 <td class="function_type">
-<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+<a href="../glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 </td>
 <td class="function_name">
 <a class="link" href="GFileMonitor.html#g-file-monitor-cancel" title="g_file_monitor_cancel ()">g_file_monitor_cancel</a> <span class="c_punctuation">()</span>
@@ -52,7 +52,7 @@
 </tr>
 <tr>
 <td class="function_type">
-<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+<a href="../glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 </td>
 <td class="function_name">
 <a class="link" href="GFileMonitor.html#g-file-monitor-is-cancelled" title="g_file_monitor_is_cancelled ()">g_file_monitor_is_cancelled</a> <span class="c_punctuation">()</span>
 </colgroup>
 <tbody>
 <tr>
-<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
+<td class="property_type"><a href="../glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
 <td class="property_name"><a class="link" href="GFileMonitor.html#GFileMonitor--cancelled" title="The “cancelled” property">cancelled</a></td>
 <td class="property_flags">Read</td>
 </tr>
 <tr>
-<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
+<td class="property_type"><a href="../glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
 <td class="property_name"><a class="link" href="GFileMonitor.html#GFileMonitor--rate-limit" title="The “rate-limit” property">rate-limit</a></td>
 <td class="property_flags">Read / Write</td>
 </tr>
 <tbody><tr>
 <td class="signal_type"><span class="returnvalue">void</span></td>
 <td class="signal_name"><a class="link" href="GFileMonitor.html#GFileMonitor-changed" title="The “changed” signal">changed</a></td>
-<td class="signal_flags"><a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
+<td class="signal_flags"><a href="../gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
 </tr></tbody>
 </table></div>
 </div>
 </div>
 <div class="refsect1">
 <a name="GFileMonitor.object-hierarchy"></a><h2>Object Hierarchy</h2>
-<pre class="screen">    <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+<pre class="screen">    <a href="../gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
     <span class="lineart">╰──</span> GFileMonitor
 </pre>
 </div>
 <p>To get informed about changes to the file or directory you are
 monitoring, connect to the <a class="link" href="GFileMonitor.html#GFileMonitor-changed" title="The “changed” signal"><span class="type">“changed”</span></a> signal. The
 signal will be emitted in the
-<a href="https://developer.gnome.org/glib/unstable/glib-The-Main-Event-Loop.html#g-main-context-push-thread-default">thread-default main context</a>
+<a href="../glib-The-Main-Event-Loop.html#g-main-context-push-thread-default">thread-default main context</a>
 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
@@ -163,11 +163,11 @@ context is still running).</p>
 <a name="GFileMonitor.functions_details"></a><h2>Functions</h2>
 <div class="refsect2">
 <a name="g-file-monitor-cancel"></a><h3>g_file_monitor_cancel ()</h3>
-<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+<pre class="programlisting"><a href="../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>
 <p>Cancels a file monitor.</p>
 <div class="refsect3">
-<a name="id-1.4.3.2.10.2.5"></a><h4>Parameters</h4>
+<a name="g-file-monitor-cancel.parameters"></a><h4>Parameters</h4>
 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -182,18 +182,18 @@ g_file_monitor_cancel (<em class="parameter"><code><a class="link" href="GFileMo
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.3.2.10.2.6"></a><h4>Returns</h4>
-<p> always <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a></p>
+<a name="g-file-monitor-cancel.returns"></a><h4>Returns</h4>
+<p> always <a href="../glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a></p>
 </div>
 </div>
 <hr>
 <div class="refsect2">
 <a name="g-file-monitor-is-cancelled"></a><h3>g_file_monitor_is_cancelled ()</h3>
-<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+<pre class="programlisting"><a href="../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>
 <p>Returns whether the monitor is canceled.</p>
 <div class="refsect3">
-<a name="id-1.4.3.2.10.3.5"></a><h4>Parameters</h4>
+<a name="g-file-monitor-is-cancelled.parameters"></a><h4>Parameters</h4>
 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -208,8 +208,8 @@ g_file_monitor_is_cancelled (<em class="parameter"><code><a class="link" href="G
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.3.2.10.3.6"></a><h4>Returns</h4>
-<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if monitor is canceled. <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
+<a name="g-file-monitor-is-cancelled.returns"></a><h4>Returns</h4>
+<p> <a href="../glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if monitor is canceled. <a href="../glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
 </div>
 </div>
 <hr>
@@ -217,12 +217,12 @@ g_file_monitor_is_cancelled (<em class="parameter"><code><a class="link" href="G
 <a name="g-file-monitor-set-rate-limit"></a><h3>g_file_monitor_set_rate_limit ()</h3>
 <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>,
-                               <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> limit_msecs</code></em>);</pre>
+                               <em class="parameter"><code><a href="../glib-Basic-Types.html#gint"><span class="type">gint</span></a> limit_msecs</code></em>);</pre>
 <p>Sets the rate limit to which the <em class="parameter"><code>monitor</code></em>
  will report
 consecutive change events to the same file.</p>
 <div class="refsect3">
-<a name="id-1.4.3.2.10.4.5"></a><h4>Parameters</h4>
+<a name="g-file-monitor-set-rate-limit.parameters"></a><h4>Parameters</h4>
 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -257,10 +257,10 @@ g_file_monitor_emit_event (<em class="parameter"><code><a class="link" href="GFi
 has taken place. Should be called from file monitor
 implementations only.</p>
 <p>Implementations are responsible to call this method from the
-<a href="https://developer.gnome.org/glib/unstable/glib-The-Main-Event-Loop.html#g-main-context-push-thread-default">thread-default main context</a> of the
+<a href="../glib-The-Main-Event-Loop.html#g-main-context-push-thread-default">thread-default main context</a> of the
 thread that the monitor was created in.</p>
 <div class="refsect3">
-<a name="id-1.4.3.2.10.5.6"></a><h4>Parameters</h4>
+<a name="g-file-monitor-emit-event.parameters"></a><h4>Parameters</h4>
 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -299,7 +299,7 @@ thread that the monitor was created in.</p>
 <a name="GFileMonitorEvent"></a><h3>enum GFileMonitorEvent</h3>
 <p>Specifies what type of event a monitor event is.</p>
 <div class="refsect3">
-<a name="id-1.4.3.2.11.2.4"></a><h4>Members</h4>
+<a name="GFileMonitorEvent.members"></a><h4>Members</h4>
 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="300px" class="enum_members_name">
@@ -369,7 +369,7 @@ thread that the monitor was created in.</p>
 <td class="enum_member_description">
 <p>the file was renamed within the
   current directory -- only sent if the <a class="link" href="GFile.html#G-FILE-MONITOR-WATCH-MOVES:CAPS"><code class="literal">G_FILE_MONITOR_WATCH_MOVES</code></a>
-  flag is set.  Since: 2.44.</p>
+  flag is set.  Since: 2.46.</p>
 </td>
 <td class="enum_member_annotations"> </td>
 </tr>
@@ -378,7 +378,7 @@ thread that the monitor was created in.</p>
 <td class="enum_member_description">
 <p>the file was moved into the
   monitored directory from another location -- only sent if the
-  <a class="link" href="GFile.html#G-FILE-MONITOR-WATCH-MOVES:CAPS"><code class="literal">G_FILE_MONITOR_WATCH_MOVES</code></a> flag is set.  Since: 2.44.</p>
+  <a class="link" href="GFile.html#G-FILE-MONITOR-WATCH-MOVES:CAPS"><code class="literal">G_FILE_MONITOR_WATCH_MOVES</code></a> flag is set.  Since: 2.46.</p>
 </td>
 <td class="enum_member_annotations"> </td>
 </tr>
@@ -387,7 +387,7 @@ thread that the monitor was created in.</p>
 <td class="enum_member_description">
 <p>the file was moved out of the
   monitored directory to another location -- only sent if the
-  <a class="link" href="GFile.html#G-FILE-MONITOR-WATCH-MOVES:CAPS"><code class="literal">G_FILE_MONITOR_WATCH_MOVES</code></a> flag is set.  Since: 2.44</p>
+  <a class="link" href="GFile.html#G-FILE-MONITOR-WATCH-MOVES:CAPS"><code class="literal">G_FILE_MONITOR_WATCH_MOVES</code></a> flag is set.  Since: 2.46</p>
 </td>
 <td class="enum_member_annotations"> </td>
 </tr>
@@ -406,7 +406,7 @@ thread that the monitor was created in.</p>
 <a name="GFileMonitor.property-details"></a><h2>Property Details</h2>
 <div class="refsect2">
 <a name="GFileMonitor--cancelled"></a><h3>The <code class="literal">“cancelled”</code> property</h3>
-<pre class="programlisting">  “cancelled”                <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
+<pre class="programlisting">  “cancelled”                <a href="../glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
 <p>Whether the monitor has been cancelled.</p>
 <p>Flags: Read</p>
 <p>Default value: FALSE</p>
@@ -414,7 +414,7 @@ thread that the monitor was created in.</p>
 <hr>
 <div class="refsect2">
 <a name="GFileMonitor--rate-limit"></a><h3>The <code class="literal">“rate-limit”</code> property</h3>
-<pre class="programlisting">  “rate-limit”               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
+<pre class="programlisting">  “rate-limit”               <a href="../glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
 <p>The limit of the monitor to watch for changes, in milliseconds.</p>
 <p>Flags: Read / Write</p>
 <p>Allowed values: &gt;= 0</p>
@@ -430,10 +430,10 @@ user_function (<a class="link" href="GFileMonitor.html" title="GFileMonitor"><sp
                <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a>            *file,
                <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a>            *other_file,
                <a class="link" href="GFileMonitor.html#GFileMonitorEvent" title="enum GFileMonitorEvent"><span class="type">GFileMonitorEvent</span></a> event_type,
-               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>          user_data)</pre>
+               <a href="../glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>          user_data)</pre>
 <p>Emitted when <em class="parameter"><code>file</code></em>
  has been changed.</p>
-<p>If using <code class="literal">G_FILE_MONITOR_WATCH_RENAMES</code> on a directory monitor, and
+<p>If using <a class="link" href="GFile.html#G-FILE-MONITOR-WATCH-MOVES:CAPS"><code class="literal">G_FILE_MONITOR_WATCH_MOVES</code></a> on a directory monitor, and
 the information is available (and if supported by the backend),
 <em class="parameter"><code>event_type</code></em>
  may be <a class="link" href="GFileMonitor.html#G-FILE-MONITOR-EVENT-RENAMED:CAPS"><code class="literal">G_FILE_MONITOR_EVENT_RENAMED</code></a>,
@@ -458,7 +458,7 @@ equivalent to <a class="link" href="GFileMonitor.html#G-FILE-MONITOR-EVENT-CREAT
 <a class="link" href="GFileMonitor.html#G-FILE-MONITOR-EVENT-DELETED:CAPS"><code class="literal">G_FILE_MONITOR_EVENT_DELETED</code></a>, with extra information.
 <a class="link" href="GFileMonitor.html#G-FILE-MONITOR-EVENT-RENAMED:CAPS"><code class="literal">G_FILE_MONITOR_EVENT_RENAMED</code></a> is equivalent to a delete/create
 pair.  This is exactly how the events will be reported in the case
-that the <code class="literal">G_FILE_MONITOR_WATCH_RENAMES</code> flag is not in use.</p>
+that the <a class="link" href="GFile.html#G-FILE-MONITOR-WATCH-MOVES:CAPS"><code class="literal">G_FILE_MONITOR_WATCH_MOVES</code></a> flag is not in use.</p>
 <p>If using the deprecated flag <a class="link" href="GFile.html#G-FILE-MONITOR-SEND-MOVED:CAPS"><code class="literal">G_FILE_MONITOR_SEND_MOVED</code></a> flag and <em class="parameter"><code>event_type</code></em>
  is
 <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>
@@ -466,9 +466,9 @@ that the <code class="literal">G_FILE_MONITOR_WATCH_RENAMES</code> flag is not i
 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.</p>
 <p>In all the other cases, <em class="parameter"><code>other_file</code></em>
- will be set to <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>.</p>
+ will be set to <a href="../glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>.</p>
 <div class="refsect3">
-<a name="id-1.4.3.2.13.2.10"></a><h4>Parameters</h4>
+<a name="GFileMonitor-changed.parameters"></a><h4>Parameters</h4>
 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -488,7 +488,7 @@ old path, and <em class="parameter"><code>other_file</code></em>
 </tr>
 <tr>
 <td class="parameter_name"><p>other_file</p></td>
-<td class="parameter_description"><p> a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>. </p></td>
+<td class="parameter_description"><p> a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> or <a href="../glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>. </p></td>
 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
 </tr>
 <tr>
@@ -504,11 +504,11 @@ old path, and <em class="parameter"><code>other_file</code></em>
 </tbody>
 </table></div>
 </div>
-<p>Flags: <a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
+<p>Flags: <a href="../gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
 </div>
 </div>
 </div>
 <div class="footer">
-<hr>Generated by GTK-Doc V1.24</div>
+<hr>Generated by GTK-Doc V1.25.1</div>
 </body>
 </html>
\ No newline at end of file