blob: ef9ca33479e168e2282e4ccf63c3552106d2ee43 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-giofilemonitor">
<refnamediv>
<refname>gio.FileMonitor</refname>
<refpurpose>File Monitor</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gio.FileMonitor</classname></ooclass>
<ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-giofilemonitor--cancel">cancel</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giofilemonitor--emit-event">emit_event</link></methodname>
<methodparam><parameter role="keyword">child</parameter></methodparam>
<methodparam><parameter role="keyword">other_file</parameter></methodparam>
<methodparam><parameter role="keyword">event_type</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giofilemonitor--is-cancelled">is_cancelled</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giofilemonitor--set-rate-limit">set_rate_limit</link></methodname>
<methodparam><parameter role="keyword">limit_msecs</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-giofilemonitor">gio.FileMonitor</link>
</synopsis>
</refsect1>
<refsect1 id="properties-giofilemonitor">
<title>gio.FileMonitor Properties</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"cancelled"</entry>
<entry>Read</entry>
<entry>
Whether the monitor has been cancelled. Default value: <literal>False</literal>.
</entry>
</row>
<row valign="top">
<entry>"rate-limit"</entry>
<entry>Read/Write</entry>
<entry>
The limit of the monitor to watch for changes, in milliseconds.
Allowed values: >= 0. Default value: 800.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="signal-prototypes-giofilemonitor">
<title>gio.FileMonitor Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<variablelist>
<varlistentry>
<term><link linkend="signal-giofilemonitor--aborted">"changed"</link></term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>filemonitor</parameter></methodparam>
<methodparam><parameter>file</parameter></methodparam>
<methodparam><parameter>other_file</parameter></methodparam>
<methodparam><parameter>event_type</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<para>
The <link linkend="class-giofilemonitor"><classname>gio.FileMonitor</classname></link>
monitors a file or directory for changes.
</para>
<para>
To obtain a <link linkend="class-giofilemonitor"><classname>gio.FileMonitor</classname></link>
for a file or directory, use
<methodname><link linkend="method-giofile--monitor">gio.FileMonitor.monitor</link></methodname>(),
<methodname><link linkend="method-giofile--monitor-file">gio.FileMonitor.monitor_file</link></methodname>(), or
<methodname><link linkend="method-giofile--monitor-directory">gio.FileMonitor.monitor_directory</link></methodname>().
</para>
<para>
To get informed about changes to the file or directory you are monitoring,
connect to the "changed" signal.
</para>
</refsect1>
<refsect1>
<title>Methods</title>
<para> Unfinished section, you may want to see the relevant C API docs for methods descriptions.</para>
</refsect1>
</refentry>
|
