Mercurial > pidgin3 / file revision

<?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-gtkblist">
<title>Buddy List signals</title>

<refsect1 id="gtkblist.signals" role="signal_proto">
<title role="signal_proto.title">List of signals</title>
<synopsis>
  &quot;<link linkend="gtkblist-gtkblist-hiding">gtkblist-hiding</link>&quot;
  &quot;<link linkend="gtkblist-gtkblist-unhiding">gtkblist-unhiding</link>&quot;
  &quot;<link linkend="gtkblist-gtkblist-created">gtkblist-created</link>&quot;
  &quot;<link linkend="gtkblist-drawing-tooltip">drawing-tooltip</link>&quot;
  &quot;<link linkend="gtkblist-drawing-buddy">drawing-buddy</link>&quot;
</synopsis>
</refsect1>

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

<refsect2 id="gtkblist-gtkblist-hiding" role="signal">
 <title>The <literal>&quot;gtkblist-hiding&quot;</literal> signal</title>
<programlisting>
void                user_function                      (PurpleBuddyList *blist,
                                                        gpointer user_data)
</programlisting>
  <para>
Emitted when the buddy list is about to be hidden.
  </para>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>blist</parameter>&#160;:</term>
    <listitem><simpara>The buddy list.</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>
  </variablelist>
</refsect2>

<refsect2 id="gtkblist-gtkblist-unhiding" role="signal">
 <title>The <literal>&quot;gtkblist-unhiding&quot;</literal> signal</title>
<programlisting>
void                user_function                      (PurpleBuddyList *blist,
                                                        gpointer user_data)
</programlisting>
  <para>
Emitted when the buddy list is about to be unhidden.
  </para>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>blist</parameter>&#160;:</term>
    <listitem><simpara>The buddy list.</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>
  </variablelist>
</refsect2>

<refsect2 id="gtkblist-gtkblist-created" role="signal">
 <title>The <literal>&quot;gtkblist-created&quot;</literal> signal</title>
<programlisting>
void                user_function                      (PurpleBuddyList *blist,
                                                        gpointer user_data)
</programlisting>
  <para>
Emitted when the buddy list is created.
  </para>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>blist</parameter>&#160;:</term>
    <listitem><simpara>The buddy list.</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>
  </variablelist>
</refsect2>

<refsect2 id="gtkblist-drawing-tooltip" role="signal">
 <title>The <literal>&quot;drawing-tooltip&quot;</literal> signal</title>
<programlisting>
void                user_function                      (PurpleBlistNode *node,
                                                        GString *text,
                                                        gboolean full,
                                                        gpointer user_data)
</programlisting>
  <para>
Emitted just before a tooltip is displayed. <literal>text</literal> is a standard GString, so the plugin can modify the text that will be displayed.
  </para>
  <note><para>
Make sure to free <literal>*text</literal> before you replace it!
  </para></note>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>node</parameter>&#160;:</term>
    <listitem><simpara>The blist node for the tooltip.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>text</parameter>&#160;:</term>
    <listitem><simpara>A pointer to the text that will be displayed.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>full</parameter>&#160;:</term>
    <listitem><simpara>Whether we're doing a full tooltip for the priority buddy or a compact tooltip for a non-priority buddy.</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>
  </variablelist>
</refsect2>

<refsect2 id="gtkblist-drawing-buddy" role="signal">
 <title>The <literal>&quot;drawing-buddy&quot;</literal> signal</title>
<programlisting>
char *              user_function                      (PurpleBuddy *buddy,
                                                        gpointer user_data)
</programlisting>
  <para>
Emitted to allow plugins to handle markup within a buddy's name or to override the default of no formatting for names shown in the buddy list.
  </para>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>buddy</parameter>&#160;:</term>
    <listitem><simpara>A pointer to the PurpleBuddy that will 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>The text to display (must be allocated), or <literal>NULL</literal> if no changes to the default behavior are desired.</simpara></listitem>
  </varlistentry>
  </variablelist>
</refsect2>

</refsect1>

</chapter>