doc/reference/libpurple/signals_cmd.xml

branch
gtkdoc-conversion
changeset 35389
884a5385bb2c
child 37033
ce8b96a22ebe
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/reference/libpurple/signals_cmd.xml	Fri Jan 31 17:31:59 2014 +0530
@@ -0,0 +1,73 @@
+<?xml version='1.0' encoding="ISO-8859-1"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+]>
+<chapter id="chapter-signals-cmd">
+<title>Command signals</title>
+
+<refsect1 id="cmds.signals" role="signal_proto">
+<title role="signal_proto.title">List of signals</title>
+<synopsis>
+  &quot;<link linkend="cmds-cmd-added">cmd-added</link>&quot;
+  &quot;<link linkend="cmds-cmd-removed">cmd-removed</link>&quot;
+</synopsis>
+</refsect1>
+
+<refsect1 id="cmds.signal-details" role="signals">
+<title role="signals.title">Signal details</title>
+
+<refsect2 id="cmds-cmd-added" role="signal">
+ <title>The <literal>&quot;cmd-added&quot;</literal> signal</title>
+<programlisting>
+void                user_function                      (const char *command,
+                                                        PurpleCmdPriority priority,
+                                                        PurpleCmdFlag flag,
+                                                        gpointer user_data)
+</programlisting>
+  <para>
+Emitted when a new command is added.
+  </para>
+  <variablelist role="params">
+  <varlistentry>
+    <term><parameter>command</parameter>&#160;:</term>
+    <listitem><simpara>The new command.</simpara></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><parameter>priority</parameter>&#160;:</term>
+    <listitem><simpara>The priority of the new command.</simpara></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><parameter>flag</parameter>&#160;:</term>
+    <listitem><simpara>The command flags.</simpara></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><parameter>user_data</parameter>&#160;:</term>
+    <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+  </varlistentry>
+  </variablelist>
+</refsect2>
+
+<refsect2 id="cmds-cmd-removed" role="signal">
+ <title>The <literal>&quot;cmd-removed&quot;</literal> signal</title>
+<programlisting>
+void                user_function                      (const char *command,
+                                                        gpointer user_data)
+</programlisting>
+  <para>
+Emitted when a command is removed.
+  </para>
+  <variablelist role="params">
+  <varlistentry>
+    <term><parameter>command</parameter>&#160;:</term>
+    <listitem><simpara>The removed command.</simpara></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><parameter>user_data</parameter>&#160;:</term>
+    <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+  </varlistentry>
+  </variablelist>
+</refsect2>
+
+</refsect1>
+
+</chapter>

mercurial