doc/reference/pidgin/signals_gtkblist.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-gtkblist">
   6 <title>Buddy List signals</title>
   7
   8 <refsect1 id="gtkblist.signals" role="signal_proto">
   9 <title role="signal_proto.title">List of signals</title>
  10 <synopsis>
  11   &quot;<link linkend="gtkblist-gtkblist-hiding">gtkblist-hiding</link>&quot;
  12   &quot;<link linkend="gtkblist-gtkblist-unhiding">gtkblist-unhiding</link>&quot;
  13   &quot;<link linkend="gtkblist-gtkblist-created">gtkblist-created</link>&quot;
  14   &quot;<link linkend="gtkblist-drawing-tooltip">drawing-tooltip</link>&quot;
  15   &quot;<link linkend="gtkblist-drawing-buddy">drawing-buddy</link>&quot;
  16 </synopsis>
  17 </refsect1>
  18
  19 <refsect1 id="gtkblist.signal-details" role="signals">
  20 <title role="signals.title">Signal details</title>
  21
  22 <refsect2 id="gtkblist-gtkblist-hiding" role="signal">
  23  <title>The <literal>&quot;gtkblist-hiding&quot;</literal> signal</title>
  24 <programlisting>
  25 void                user_function                      (PurpleBuddyList *blist,
  26                                                         gpointer user_data)
  27 </programlisting>
  28   <para>
  29 Emitted when the buddy list is about to be hidden.
  30   </para>
  31   <variablelist role="params">
  32   <varlistentry>
  33     <term><parameter>blist</parameter>&#160;:</term>
  34     <listitem><simpara>The buddy list.</simpara></listitem>
  35   </varlistentry>
  36   <varlistentry>
  37     <term><parameter>user_data</parameter>&#160;:</term>
  38     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  39   </varlistentry>
  40   </variablelist>
  41 </refsect2>
  42
  43 <refsect2 id="gtkblist-gtkblist-unhiding" role="signal">
  44  <title>The <literal>&quot;gtkblist-unhiding&quot;</literal> signal</title>
  45 <programlisting>
  46 void                user_function                      (PurpleBuddyList *blist,
  47                                                         gpointer user_data)
  48 </programlisting>
  49   <para>
  50 Emitted when the buddy list is about to be unhidden.
  51   </para>
  52   <variablelist role="params">
  53   <varlistentry>
  54     <term><parameter>blist</parameter>&#160;:</term>
  55     <listitem><simpara>The buddy list.</simpara></listitem>
  56   </varlistentry>
  57   <varlistentry>
  58     <term><parameter>user_data</parameter>&#160;:</term>
  59     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  60   </varlistentry>
  61   </variablelist>
  62 </refsect2>
  63
  64 <refsect2 id="gtkblist-gtkblist-created" role="signal">
  65  <title>The <literal>&quot;gtkblist-created&quot;</literal> signal</title>
  66 <programlisting>
  67 void                user_function                      (PurpleBuddyList *blist,
  68                                                         gpointer user_data)
  69 </programlisting>
  70   <para>
  71 Emitted when the buddy list is created.
  72   </para>
  73   <variablelist role="params">
  74   <varlistentry>
  75     <term><parameter>blist</parameter>&#160;:</term>
  76     <listitem><simpara>The buddy list.</simpara></listitem>
  77   </varlistentry>
  78   <varlistentry>
  79     <term><parameter>user_data</parameter>&#160;:</term>
  80     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  81   </varlistentry>
  82   </variablelist>
  83 </refsect2>
  84
  85 <refsect2 id="gtkblist-drawing-tooltip" role="signal">
  86  <title>The <literal>&quot;drawing-tooltip&quot;</literal> signal</title>
  87 <programlisting>
  88 void                user_function                      (PurpleBlistNode *node,
  89                                                         GString *text,
  90                                                         gboolean full,
  91                                                         gpointer user_data)
  92 </programlisting>
  93   <para>
  94 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.
  95   </para>
  96   <note><para>
  97 Make sure to free <literal>*text</literal> before you replace it!
  98   </para></note>
  99   <variablelist role="params">
 100   <varlistentry>
 101     <term><parameter>node</parameter>&#160;:</term>
 102     <listitem><simpara>The blist node for the tooltip.</simpara></listitem>
 103   </varlistentry>
 104   <varlistentry>
 105     <term><parameter>text</parameter>&#160;:</term>
 106     <listitem><simpara>A pointer to the text that will be displayed.</simpara></listitem>
 107   </varlistentry>
 108   <varlistentry>
 109     <term><parameter>full</parameter>&#160;:</term>
 110     <listitem><simpara>Whether we're doing a full tooltip for the priority buddy or a compact tooltip for a non-priority buddy.</simpara></listitem>
 111   </varlistentry>
 112   <varlistentry>
 113     <term><parameter>user_data</parameter>&#160;:</term>
 114     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
 115   </varlistentry>
 116   </variablelist>
 117 </refsect2>
 118
 119 <refsect2 id="gtkblist-drawing-buddy" role="signal">
 120  <title>The <literal>&quot;drawing-buddy&quot;</literal> signal</title>
 121 <programlisting>
 122 char *              user_function                      (PurpleBuddy *buddy,
 123                                                         gpointer user_data)
 124 </programlisting>
 125   <para>
 126 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.
 127   </para>
 128   <variablelist role="params">
 129   <varlistentry>
 130     <term><parameter>buddy</parameter>&#160;:</term>
 131     <listitem><simpara>A pointer to the PurpleBuddy that will be displayed.</simpara></listitem>
 132   </varlistentry>
 133   <varlistentry>
 134     <term><parameter>user_data</parameter>&#160;:</term>
 135     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
 136   </varlistentry>
 137   <varlistentry>
 138     <term><emphasis>Returns</emphasis>&#160;:</term>
 139     <listitem><simpara>The text to display (must be allocated), or <literal>NULL</literal> if no changes to the default behavior are desired.</simpara></listitem>
 140   </varlistentry>
 141   </variablelist>
 142 </refsect2>
 143
 144 </refsect1>
 145
 146 </chapter>