← Back to branch summary

~ubuntu-branches/debian/jessie/glib2.0/jessie

« back to all changes in this revision

Viewing changes to docs/reference/gio/html/GFileMonitor.html

  • Committer: Package Import Robot
  • Author(s): Iain Lane
  • Date: 2014-09-23 10:12:15 UTC
  • mto: This revision was merged to the branch mainline in revision 120.
  • Revision ID: package-import@ubuntu.com-20140923101215-kg4894xy8gz996q1
Tags: upstream-2.42.0
Import upstream version 2.42.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/html/GFileMonitor.html
44
44
<tbody>
45
45
<tr>
46
46
<td class="function_type">
47
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
47
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
48
48
</td>
49
49
<td class="function_name">
50
50
<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
52
</tr>
53
53
<tr>
54
54
<td class="function_type">
55
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
55
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
56
56
</td>
57
57
<td class="function_name">
58
58
<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>
87
87
</colgroup>
88
88
<tbody>
89
89
<tr>
90
 
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
 
90
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
91
91
<td class="property_name"><a class="link" href="GFileMonitor.html#GFileMonitor--cancelled" title="The “cancelled” property">cancelled</a></td>
92
92
<td class="property_flags">Read</td>
93
93
</tr>
94
94
<tr>
95
95
<td class="property_type">
96
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *</td>
 
96
<a href="../glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *</td>
97
97
<td class="property_name"><a class="link" href="GFileMonitor.html#GFileMonitor--context" title="The “context” property">context</a></td>
98
98
<td class="property_flags">Write / Construct Only</td>
99
99
</tr>
100
100
<tr>
101
 
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
 
101
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
102
102
<td class="property_name"><a class="link" href="GFileMonitor.html#GFileMonitor--rate-limit" title="The “rate-limit” property">rate-limit</a></td>
103
103
<td class="property_flags">Read / Write</td>
104
104
</tr>
141
141
</div>
142
142
<div class="refsect1">
143
143
<a name="GFileMonitor.object-hierarchy"></a><h2>Object Hierarchy</h2>
144
 
<pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
144
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
145
145
    <span class="lineart">╰──</span> GFileMonitor
146
146
</pre>
147
147
</div>
159
159
<p>To get informed about changes to the file or directory you are
160
160
monitoring, connect to the <a class="link" href="GFileMonitor.html#GFileMonitor-changed" title="The “changed” signal"><span class="type">“changed”</span></a> signal. The
161
161
signal will be emitted in the
162
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-main-context-push-thread-default">thread-default main context</a>
 
162
<a href="../glib/glib-The-Main-Event-Loop.html#g-main-context-push-thread-default">thread-default main context</a>
163
163
of the thread that the monitor was created in
164
164
(though if the global default main context is blocked, this may
165
165
cause notifications to be blocked even if the thread-default
169
169
<a name="GFileMonitor.functions_details"></a><h2>Functions</h2>
170
170
<div class="refsect2">
171
171
<a name="g-file-monitor-cancel"></a><h3>g_file_monitor_cancel ()</h3>
172
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
172
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
173
173
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>
174
174
<p>Cancels a file monitor.</p>
175
175
<div class="refsect3">
189
189
</div>
190
190
<div class="refsect3">
191
191
<a name="id-1.4.3.2.10.2.6"></a><h4>Returns</h4>
192
 
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if monitor was cancelled.</p>
 
192
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if monitor was cancelled.</p>
193
193
<p></p>
194
194
</div>
195
195
</div>
196
196
<hr>
197
197
<div class="refsect2">
198
198
<a name="g-file-monitor-is-cancelled"></a><h3>g_file_monitor_is_cancelled ()</h3>
199
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
199
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
200
200
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>
201
201
<p>Returns whether the monitor is canceled.</p>
202
202
<div class="refsect3">
216
216
</div>
217
217
<div class="refsect3">
218
218
<a name="id-1.4.3.2.10.3.6"></a><h4>Returns</h4>
219
 
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if monitor is canceled. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
 
219
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if monitor is canceled. <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
220
220
<p></p>
221
221
</div>
222
222
</div>
225
225
<a name="g-file-monitor-set-rate-limit"></a><h3>g_file_monitor_set_rate_limit ()</h3>
226
226
<pre class="programlisting"><span class="returnvalue">void</span>
227
227
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>,
228
 
                               <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> limit_msecs</code></em>);</pre>
 
228
                               <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> limit_msecs</code></em>);</pre>
229
229
<p>Sets the rate limit to which the <em class="parameter"><code>monitor</code></em>
230
230
 will report
231
231
consecutive change events to the same file.</p>
265
265
has taken place. Should be called from file monitor 
266
266
implementations only.</p>
267
267
<p>The signal will be emitted from an idle handler (in the
268
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-main-context-push-thread-default">thread-default main context</a>).</p>
 
268
<a href="../glib/glib-The-Main-Event-Loop.html#g-main-context-push-thread-default">thread-default main context</a>).</p>
269
269
<div class="refsect3">
270
270
<a name="id-1.4.3.2.10.5.6"></a><h4>Parameters</h4>
271
271
<div class="informaltable"><table width="100%" border="0">
385
385
<a name="GFileMonitor.property-details"></a><h2>Property Details</h2>
386
386
<div class="refsect2">
387
387
<a name="GFileMonitor--cancelled"></a><h3>The <code class="literal">“cancelled”</code> property</h3>
388
 
<pre class="programlisting">  “cancelled”                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
 
388
<pre class="programlisting">  “cancelled”                <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
389
389
<p>Whether the monitor has been cancelled.</p>
390
390
<p>Flags: Read</p>
391
391
<p>Default value: FALSE</p>
393
393
<hr>
394
394
<div class="refsect2">
395
395
<a name="GFileMonitor--context"></a><h3>The <code class="literal">“context”</code> property</h3>
396
 
<pre class="programlisting">  “context”                  <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *</pre>
 
396
<pre class="programlisting">  “context”                  <a href="../glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *</pre>
397
397
<p>The main context to dispatch from.</p>
398
398
<p>Flags: Write / Construct Only</p>
399
399
</div>
400
400
<hr>
401
401
<div class="refsect2">
402
402
<a name="GFileMonitor--rate-limit"></a><h3>The <code class="literal">“rate-limit”</code> property</h3>
403
 
<pre class="programlisting">  “rate-limit”               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
 
403
<pre class="programlisting">  “rate-limit”               <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
404
404
<p>The limit of the monitor to watch for changes, in milliseconds.</p>
405
405
<p>Flags: Read / Write</p>
406
406
<p>Allowed values: &gt;= 0</p>
416
416
               <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a>            *file,
417
417
               <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a>            *other_file,
418
418
               <a class="link" href="GFileMonitor.html#GFileMonitorEvent" title="enum GFileMonitorEvent"><span class="type">GFileMonitorEvent</span></a> event_type,
419
 
               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>          user_data)</pre>
 
419
               <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>          user_data)</pre>
420
420
<p>Emitted when <em class="parameter"><code>file</code></em>
421
421
 has been changed.</p>
422
422
<p>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>
426
426
old path, and <em class="parameter"><code>other_file</code></em>
427
427
 will be set to a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> containing the new path.</p>
428
428
<p>In all the other cases, <em class="parameter"><code>other_file</code></em>
429
 
 will be set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>.</p>
 
429
 will be set to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>.</p>
430
430
<div class="refsect3">
431
431
<a name="id-1.4.3.2.13.2.7"></a><h4>Parameters</h4>
432
432
<div class="informaltable"><table width="100%" border="0">
448
448
</tr>
449
449
<tr>
450
450
<td class="parameter_name"><p>other_file</p></td>
451
 
<td class="parameter_description"><p> a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>. </p></td>
 
451
<td class="parameter_description"><p> a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>. </p></td>
452
452
<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>
453
453
</tr>
454
454
<tr>