doc/reference/libpurple/signals_core.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-core">
   6 <title>Core signals</title>
   7
   8 <refsect1 id="core.signals" role="signal_proto">
   9 <title role="signal_proto.title">List of signals</title>
  10 <synopsis>
  11   &quot;<link linkend="core-quitting">quitting</link>&quot;
  12   &quot;<link linkend="core-uri-handler">uri-handler</link>&quot;
  13 </synopsis>
  14 </refsect1>
  15
  16 <refsect1 id="core.signal-details" role="signals">
  17 <title role="signals.title">Signal details</title>
  18
  19 <refsect2 id="core-quitting" role="signal">
  20  <title>The <literal>&quot;quitting&quot;</literal> signal</title>
  21 <programlisting>
  22 void                user_function                      (gpointer user_data)
  23 </programlisting>
  24   <para>
  25 Emitted when libpurple is quitting.
  26   </para>
  27   <variablelist role="params">
  28   <varlistentry>
  29     <term><parameter>user_data</parameter>&#160;:</term>
  30     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  31   </varlistentry>
  32   </variablelist>
  33 </refsect2>
  34
  35 <refsect2 id="core-uri-handler" role="signal">
  36  <title>The <literal>&quot;uri-handler&quot;</literal> signal</title>
  37 <programlisting>
  38 gboolean            user_function                      (const gchar *proto,
  39                                                         const gchar *cmd,
  40                                                         GHashTable *params,
  41                                                         gpointer user_data)
  42 </programlisting>
  43   <para>
  44 Emitted when handling a registered URI.
  45   </para>
  46   <variablelist role="params">
  47   <varlistentry>
  48     <term><parameter>proto</parameter>&#160;:</term>
  49     <listitem><simpara>The protocol of the URI.</simpara></listitem>
  50   </varlistentry>
  51   <varlistentry>
  52     <term><parameter>cmd</parameter>&#160;:</term>
  53     <listitem><simpara>The 'command' of the URI.</simpara></listitem>
  54   </varlistentry>
  55   <varlistentry>
  56     <term><parameter>params</parameter>&#160;:</term>
  57     <listitem><simpara>Any key/value parameters from the URI.</simpara></listitem>
  58   </varlistentry>
  59   <varlistentry>
  60     <term><parameter>user_data</parameter>&#160;:</term>
  61     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  62   </varlistentry>
  63   </variablelist>
  64 </refsect2>
  65
  66 </refsect1>
  67
  68 </chapter>