doc/reference/libpurple/signals_log.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-log">
   6 <title>Log signals</title>
   7
   8 <refsect1 id="logs.signals" role="signal_proto">
   9 <title role="signal_proto.title">List of signals</title>
  10 <synopsis>
  11   &quot;<link linkend="logs-log-timestamp">log-timestamp</link>&quot;
  12 </synopsis>
  13 </refsect1>
  14
  15 <refsect1 id="logs.signal-details" role="signals">
  16 <title role="signals.title">Signal details</title>
  17
  18 <refsect2 id="logs-log-timestamp" role="signal">
  19  <title>The <literal>&quot;log-timestamp&quot;</literal> signal</title>
  20 <programlisting>
  21 char *              user_function                      (PurpleLog *log,
  22                                                         time_t when,
  23                                                         gboolean show_date,
  24                                                         gpointer user_data)
  25 </programlisting>
  26   <para>
  27 Emitted to allow plugins to customize the timestamp on a message being logged.
  28   </para>
  29   <note><para>
  30 Plugins must be careful of logs with a type of PURPLE_LOG_SYSTEM.
  31   </para></note>
  32   <variablelist role="params">
  33   <varlistentry>
  34     <term><parameter>log</parameter>&#160;:</term>
  35     <listitem><simpara>The log the message belongs to.</simpara></listitem>
  36   </varlistentry>
  37   <varlistentry>
  38     <term><parameter>when</parameter>&#160;:</term>
  39     <listitem><simpara>The time to be converted to a string.</simpara></listitem>
  40   </varlistentry>
  41   <varlistentry>
  42     <term><parameter>show_date</parameter>&#160;:</term>
  43     <listitem><simpara>Whether the date should be displayed.</simpara></listitem>
  44   </varlistentry>
  45   <varlistentry>
  46     <term><parameter>user_data</parameter>&#160;:</term>
  47     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  48   </varlistentry>
  49   <varlistentry>
  50     <term><emphasis>Returns</emphasis>&#160;:</term>
  51     <listitem><simpara>A textual representation of the time, or <literal>NULL</literal> to use a default format.</simpara></listitem>
  52   </varlistentry>
  53   </variablelist>
  54 </refsect2>
  55
  56 </refsect1>
  57
  58 </chapter>