doc/reference/libpurple/signals_cmd.xml

   1 <?xml version='1.0' encoding="ISO-8859-1"?>
   2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 ]>
   5 <chapter id="chapter-signals-cmd">
   6 <title>Command signals</title>
   7
   8 <refsect1 id="cmds.signals" role="signal_proto">
   9 <title role="signal_proto.title">List of signals</title>
  10 <synopsis>
  11   &quot;<link linkend="cmds-cmd-added">cmd-added</link>&quot;
  12   &quot;<link linkend="cmds-cmd-removed">cmd-removed</link>&quot;
  13 </synopsis>
  14 </refsect1>
  15
  16 <refsect1 id="cmds.signal-details" role="signals">
  17 <title role="signals.title">Signal details</title>
  18
  19 <refsect2 id="cmds-cmd-added" role="signal">
  20  <title>The <literal>&quot;cmd-added&quot;</literal> signal</title>
  21 <programlisting>
  22 void                user_function                      (const char *command,
  23                                                         PurpleCmdPriority priority,
  24                                                         PurpleCmdFlag flag,
  25                                                         gpointer user_data)
  26 </programlisting>
  27   <para>
  28 Emitted when a new command is added.
  29   </para>
  30   <variablelist role="params">
  31   <varlistentry>
  32     <term><parameter>command</parameter>&#160;:</term>
  33     <listitem><simpara>The new command.</simpara></listitem>
  34   </varlistentry>
  35   <varlistentry>
  36     <term><parameter>priority</parameter>&#160;:</term>
  37     <listitem><simpara>The priority of the new command.</simpara></listitem>
  38   </varlistentry>
  39   <varlistentry>
  40     <term><parameter>flag</parameter>&#160;:</term>
  41     <listitem><simpara>The command flags.</simpara></listitem>
  42   </varlistentry>
  43   <varlistentry>
  44     <term><parameter>user_data</parameter>&#160;:</term>
  45     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  46   </varlistentry>
  47   </variablelist>
  48 </refsect2>
  49
  50 <refsect2 id="cmds-cmd-removed" role="signal">
  51  <title>The <literal>&quot;cmd-removed&quot;</literal> signal</title>
  52 <programlisting>
  53 void                user_function                      (const char *command,
  54                                                         gpointer user_data)
  55 </programlisting>
  56   <para>
  57 Emitted when a command is removed.
  58   </para>
  59   <variablelist role="params">
  60   <varlistentry>
  61     <term><parameter>command</parameter>&#160;:</term>
  62     <listitem><simpara>The removed command.</simpara></listitem>
  63   </varlistentry>
  64   <varlistentry>
  65     <term><parameter>user_data</parameter>&#160;:</term>
  66     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  67   </varlistentry>
  68   </variablelist>
  69 </refsect2>
  70
  71 </refsect1>
  72
  73 </chapter>