diff options
| -rw-r--r-- | docs/Makefile.am | 2 | ||||
| -rw-r--r-- | docs/reference/pygio-classes.xml | 1 | ||||
| -rw-r--r-- | docs/reference/pygio-filemonitor.xml | 128 |
3 files changed, 131 insertions, 0 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 8da8476..62c4dc9 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -28,6 +28,7 @@ HTML_FILES = \ html/class-giofileenumerator.html \ html/class-giofileicon.html \ html/class-giofileinfo.html \ + html/class-giofilemonitor.html \ html/class-gioicon.html \ html/class-gioinputstream.html \ html/class-gioloadableicon.html \ @@ -77,6 +78,7 @@ XML_FILES = \ reference/pygio-fileenumerator.xml \ reference/pygio-fileicon.xml \ reference/pygio-fileinfo.xml \ + reference/pygio-filemonitor.xml \ reference/pygio-icon.xml \ reference/pygio-inputstream.xml \ reference/pygio-loadableicon.xml \ diff --git a/docs/reference/pygio-classes.xml b/docs/reference/pygio-classes.xml index e4f2b53..cb9b70f 100644 --- a/docs/reference/pygio-classes.xml +++ b/docs/reference/pygio-classes.xml @@ -19,6 +19,7 @@ <xi:include href="pygio-fileenumerator.xml"/> <xi:include href="pygio-fileicon.xml"/> <xi:include href="pygio-fileinfo.xml"/> +<xi:include href="pygio-filemonitor.xml"/> <xi:include href="pygio-icon.xml"/> <xi:include href="pygio-inputstream.xml"/> <xi:include href="pygio-loadableicon.xml"/> diff --git a/docs/reference/pygio-filemonitor.xml b/docs/reference/pygio-filemonitor.xml new file mode 100644 index 0000000..ef9ca33 --- /dev/null +++ b/docs/reference/pygio-filemonitor.xml @@ -0,0 +1,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> |