diff options
| author | Johan Dahlin <jdahlin@async.com.br> | 2008-06-28 12:44:38 +0000 |
|---|---|---|
| committer | Johan Dahlin <johan@src.gnome.org> | 2008-06-28 12:44:38 +0000 |
| commit | 50f42c6c5171af96394cc1ffe41fcc8269cbc95a (patch) | |
| tree | 41dff3668385c25ba203909d0e68a681b406db10 /docs | |
| parent | de5fce1737f04bfe525caeab390b55bd46037d67 (diff) | |
| download | pygobject-50f42c6c5171af96394cc1ffe41fcc8269cbc95a.tar.gz pygobject-50f42c6c5171af96394cc1ffe41fcc8269cbc95a.tar.xz pygobject-50f42c6c5171af96394cc1ffe41fcc8269cbc95a.zip | |
Document GObject.handler_block_by_func/handler_unblock_by_func
2008-06-28 Johan Dahlin <jdahlin@async.com.br>
* docs/reference/pygobject.xml:
Document GObject.handler_block_by_func/handler_unblock_by_func
svn path=/trunk/; revision=789
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/reference/pygobject.xml | 52 |
1 files changed, 49 insertions, 3 deletions
diff --git a/docs/reference/pygobject.xml b/docs/reference/pygobject.xml index f8c6df2..ac41e47 100644 --- a/docs/reference/pygobject.xml +++ b/docs/reference/pygobject.xml @@ -117,6 +117,16 @@ linkend="method-gobject--handler-unblock">handler_unblock</link></methodname> </methodsynopsis> <methodsynopsis language="python"> <methodname><link +linkend="method-gobject--handler-block-by-func">handler_block_by_func</link></methodname> + <methodparam><parameter>callable</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link +linkend="method-gobject--handler-unblock-by-func">handler_unblock_by_func</link></methodname> + <methodparam><parameter>callable</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gobject--emit">emit</link></methodname> <methodparam><parameter>detailed_signal</parameter></methodparam> </methodsynopsis> @@ -797,9 +807,45 @@ identifier</simpara></listitem> </varlistentry> </variablelist> - <para>The <methodname>handler_unblock</methodname>() method unblocks -the signal handler with the specified <parameter>handler_id</parameter> -thereby allowing it to be invoked when the associated signal is + </refsect2> + + <refsect2 id="method-gobject--handler-block-by-func"> + <title>gobject.GObject.handler_block_by_func</title> + + <programlisting><methodsynopsis language="python"> + <methodname>handler_block_by_func</methodname> + <methodparam><parameter>callable</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter>callable</parameter> :</term> + <listitem><simpara>a callable python object</simpara></listitem> + </varlistentry> + </variablelist> + + <para>The <methodname>handler_block_by_func</methodname>() method blocks the +all signal handler connected to a specific <parameter>callable</parameter> from +being invoked until the callable is unblocked.</para> + + </refsect2> + + <refsect2 id="method-gobject--handler-unblock-by-func"> + <title>gobject.GObject.handler_unblock_by_func</title> + + <programlisting><methodsynopsis language="python"> + <methodname>handler_unblock_by_func</methodname> + <methodparam><parameter>callback</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter>callable</parameter> :</term> + <listitem><simpara>a callable python object</simpara></listitem> + </varlistentry> + </variablelist> + + <para>The <methodname>handler_unblock_by_func</methodname>() method unblocks +all signal handler connected to a specified <parameter>callable</parameter> +thereby allowing it to be invoked when the associated signals are emitted.</para> </refsect2> |