summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMartin Pitt <martinpitt@gnome.org>2012-10-28 14:15:05 +0100
committerMartin Pitt <martinpitt@gnome.org>2012-10-28 14:15:05 +0100
commit70d78eee4a04dcaefea4615fe351e33fa717dffa (patch)
treea85f180b09c7dbc4101379c9fed17e44b0799321 /docs
parent4b16427714b850e33c6020d8de1833bae19a3b87 (diff)
downloadpygobject-70d78eee4a04dcaefea4615fe351e33fa717dffa.tar.gz
Remove static child_add_watch() binding
Use the GLib API through GI instead, and provide override to keep backwards compatible API. Also allow using the actual GLib API, and deprecate the old static API of calling without a priority as first argument.
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/pyglib-functions.xml61
1 files changed, 0 insertions, 61 deletions
diff --git a/docs/reference/pyglib-functions.xml b/docs/reference/pyglib-functions.xml
index 936f7508..fa1c210f 100644
--- a/docs/reference/pyglib-functions.xml
+++ b/docs/reference/pyglib-functions.xml
@@ -13,12 +13,6 @@
<programlisting>
<methodsynopsis language="python">
- <methodname><link linkend="function-glib--child-watch-add">glib.child_watch_add</link></methodname>
- <methodparam><parameter role="keyword">pid</parameter></methodparam>
- <methodparam><parameter role="keyword">function</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">priority</parameter><initializer>glib.PRIORITY_DEFAULT</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
<methodname><link
linkend="function-glib--spawn-async">glib.spawn_async</link></methodname>
<methodparam><parameter role="keyword">argv</parameter></methodparam>
@@ -91,61 +85,6 @@ line endings and attribute values.</para>
</refsect2>
- <refsect2 id="function-glib--child-watch-add">
- <title>glib.child_watch_add</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>glib.child_watch_add</methodname>
- <methodparam><parameter role="keyword">pid</parameter></methodparam>
- <methodparam><parameter role="keyword">function</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">priority</parameter><initializer>glib.PRIORITY_DEFAULT</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist role="params">
- <varlistentry>
- <term><parameter role="keyword">pid</parameter>&nbsp;:</term>
- <listitem><simpara>process id of a child process to watch</simpara></listitem>
- </varlistentry>
- <varlistentry><term><parameter role="keyword">function</parameter>&nbsp;:</term>
- <listitem><simpara>the function to call</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>the optional data to pass to
-<parameter>function</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">priority</parameter>&nbsp;:</term>
- <listitem><simpara>the priority of the idle source - one of the
-<xref linkend="glib-priority-constants"
-endterm="glib-priority-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the id of event source.</simpara></listitem>
- </varlistentry>
- </variablelist>
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>glib.child_watch_add</function>() function sets
-the function specified by <parameter>function</parameter> to be called with
-the user data specified by <parameter>data</parameter> when the child
-indicated by <parameter>pid</parameter> exits. The signature for the
-callback is:</para>
-
- <programlisting>
-def callback(pid, condition, user_data)
-</programlisting>
-
- <para>where <parameter>pid</parameter> is is the child process id,
-<parameter>condition</parameter> is the status information about the child
-process and <parameter>user_data</parameter> is <parameter>data</parameter>
-PyGTK supports only a single callback per process id.</para>
-
- </refsect2>
-
<refsect2 id="function-glib--spawn-async">
<title>glib.spawn_async</title>