doc/reference/libpurple/signals_protocol.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-protocol">
   6 <title>Protocol signals</title>
   7
   8 <refsect1 id="protocols.signals" role="signal_proto">
   9 <title role="signal_proto.title">List of signals</title>
  10 <synopsis>
  11   &quot;<link linkend="protocols-protocol-added">protocol-added</link>&quot;
  12   &quot;<link linkend="protocols-protocol-removed">protocol-removed</link>&quot;
  13 </synopsis>
  14 </refsect1>
  15
  16 <refsect1 id="protocols.signal-details" role="signals">
  17 <title role="signals.title">Signal details</title>
  18
  19 <refsect2 id="protocols-protocol-added" role="signal">
  20  <title>The <literal>&quot;protocol-added&quot;</literal> signal</title>
  21 <programlisting>
  22 void                user_function                      (PurpleProtocol *protocol,
  23                                                         gpointer user_data)
  24 </programlisting>
  25   <para>
  26 Emitted when a protocol is added.
  27   </para>
  28   <variablelist role="params">
  29   <varlistentry>
  30     <term><parameter>protocol</parameter>&#160;:</term>
  31     <listitem><simpara>The protocol that was added.</simpara></listitem>
  32   </varlistentry>
  33   <varlistentry>
  34     <term><parameter>user_data</parameter>&#160;:</term>
  35     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  36   </varlistentry>
  37   </variablelist>
  38 </refsect2>
  39
  40 <refsect2 id="protocols-protocol-removed" role="signal">
  41  <title>The <literal>&quot;protocol-removed&quot;</literal> signal</title>
  42 <programlisting>
  43 void                user_function                      (PurpleProtocol *protocol,
  44                                                         gpointer user_data)
  45 </programlisting>
  46   <para>
  47 Emitted when a protocol is removed.
  48   </para>
  49   <variablelist role="params">
  50   <varlistentry>
  51     <term><parameter>protocol</parameter>&#160;:</term>
  52     <listitem><simpara>The protocol that was removed.</simpara></listitem>
  53   </varlistentry>
  54   <varlistentry>
  55     <term><parameter>user_data</parameter>&#160;:</term>
  56     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  57   </varlistentry>
  58   </variablelist>
  59 </refsect2>
  60
  61 </refsect1>
  62
  63 </chapter>