From 84ab6178ed0033f69932df5bc73c86bdff80c953 Mon Sep 17 00:00:00 2001 From: Gian Mario Tagliaretti Date: Sun, 17 May 2009 17:29:37 +0200 Subject: Add documentation for the gio.FileMonitor class The docs for this class are not completed, missing methods descriptions. The index is complete though, it will be completed once all the classes are in place so we can ship a (almost) complete reference. --- docs/reference/pygio-classes.xml | 1 + docs/reference/pygio-filemonitor.xml | 128 +++++++++++++++++++++++++++++++++++ 2 files changed, 129 insertions(+) create mode 100644 docs/reference/pygio-filemonitor.xml (limited to 'docs/reference') 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 @@ + 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 @@ + + + + + + gio.FileMonitor + File Monitor + + + + Synopsis + + + gio.FileMonitor + gobject.GObject + + + cancel + + + + emit_event + child + other_file + event_type + + + is_cancelled + + + + set_rate_limit + limit_msecs + + + + + + + Ancestry + ++-- gobject.GObject + +-- gio.FileMonitor + + + + + + gio.FileMonitor Properties + +
+ + + + + + + + "cancelled" + Read + + Whether the monitor has been cancelled. Default value: False. + + + + "rate-limit" + Read/Write + + The limit of the monitor to watch for changes, in milliseconds. + Allowed values: >= 0. Default value: 800. + + + + + +
+ + + + + gio.FileMonitor Signal Prototypes + + gobject.GObject Signal Prototypes + + + + "changed" + + callback + filemonitor + file + other_file + event_type + user_param1 + ... + + + + + + + + + Description + + + The gio.FileMonitor + monitors a file or directory for changes. + + + To obtain a gio.FileMonitor + for a file or directory, use + gio.FileMonitor.monitor(), + gio.FileMonitor.monitor_file(), or + gio.FileMonitor.monitor_directory(). + + + To get informed about changes to the file or directory you are monitoring, + connect to the "changed" signal. + + + + + Methods + Unfinished section, you may want to see the relevant C API docs for methods descriptions. + + -- cgit