doc/reference/libpurple/signals_log.xml

<?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-log">
<title>Log signals</title>

<refsect1 id="logs.signals" role="signal_proto">
<title role="signal_proto.title">List of signals</title>
<synopsis>
  &quot;<link linkend="logs-log-timestamp">log-timestamp</link>&quot;
</synopsis>
</refsect1>

<refsect1 id="logs.signal-details" role="signals">
<title role="signals.title">Signal details</title>

<refsect2 id="logs-log-timestamp" role="signal">
 <title>The <literal>&quot;log-timestamp&quot;</literal> signal</title>
<programlisting>
char *              user_function                      (PurpleLog *log,
                                                        time_t when,
                                                        gboolean show_date,
                                                        gpointer user_data)
</programlisting>
  <para>
Emitted to allow plugins to customize the timestamp on a message being logged.
  </para>
  <note><para>
Plugins must be careful of logs with a type of PURPLE_LOG_SYSTEM.
  </para></note>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>log</parameter>&#160;:</term>
    <listitem><simpara>The log the message belongs to.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>when</parameter>&#160;:</term>
    <listitem><simpara>The time to be converted to a string.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>show_date</parameter>&#160;:</term>
    <listitem><simpara>Whether the date should be displayed.</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>
  <varlistentry>
    <term><emphasis>Returns</emphasis>&#160;:</term>
    <listitem><simpara>A textual representation of the time, or <literal>NULL</literal> to use a default format.</simpara></listitem>
  </varlistentry>
  </variablelist>
</refsect2>

</refsect1>

</chapter>