doc/reference/libpurple/signals_blist.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-blist">
   6 <title>Buddy List signals</title>
   7
   8 <refsect1 id="blist.signals" role="signal_proto">
   9 <title role="signal_proto.title">List of signals</title>
  10 <synopsis>
  11   &quot;<link linkend="blist-buddy-status-changed">buddy-status-changed</link>&quot;
  12   &quot;<link linkend="blist-buddy-idle-changed">buddy-idle-changed</link>&quot;
  13   &quot;<link linkend="blist-buddy-signed-on">buddy-signed-on</link>&quot;
  14   &quot;<link linkend="blist-buddy-signed-off">buddy-signed-off</link>&quot;
  15   &quot;<link linkend="blist-update-idle">update-idle</link>&quot;
  16   &quot;<link linkend="blist-blist-node-extended-menu">blist-node-extended-menu</link>&quot;
  17   &quot;<link linkend="blist-buddy-icon-changed">buddy-icon-changed</link>&quot;
  18   &quot;<link linkend="blist-blist-node-aliased">blist-node-aliased</link>&quot;
  19   &quot;<link linkend="blist-buddy-caps-changed">buddy-caps-changed</link>&quot;
  20   &quot;<link linkend="blist-ui-caps-changed">ui-caps-changed</link>&quot;
  21 </synopsis>
  22 </refsect1>
  23
  24 <refsect1 id="blist.signal-details" role="signals">
  25 <title role="signals.title">Signal details</title>
  26
  27 <refsect2 id="blist-buddy-status-changed" role="signal">
  28  <title>The <literal>&quot;buddy-status-changed&quot;</literal> signal</title>
  29 <programlisting>
  30 void                user_function                      (PurpleBuddy *buddy,
  31                                                         PurpleStatus *old_status,
  32                                                         PurpleStatus *status,
  33                                                         gpointer user_data)
  34 </programlisting>
  35   <para>
  36 Emitted when a buddy on your buddy list goes away.
  37   </para>
  38   <variablelist role="params">
  39   <varlistentry>
  40     <term><parameter>buddy</parameter>&#160;:</term>
  41     <listitem><simpara>The buddy whose status changed.</simpara></listitem>
  42   </varlistentry>
  43   <varlistentry>
  44     <term><parameter>old_status</parameter>&#160;:</term>
  45     <listitem><simpara>The status that the buddy just changed from.</simpara></listitem>
  46   </varlistentry>
  47   <varlistentry>
  48     <term><parameter>status</parameter>&#160;:</term>
  49     <listitem><simpara>The status that the buddy just changed to.</simpara></listitem>
  50   </varlistentry>
  51   <varlistentry>
  52     <term><parameter>user_data</parameter>&#160;:</term>
  53     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  54   </varlistentry>
  55   </variablelist>
  56 </refsect2>
  57
  58 <refsect2 id="blist-buddy-idle-changed" role="signal">
  59  <title>The <literal>&quot;buddy-idle-changed&quot;</literal> signal</title>
  60 <programlisting>
  61 void                user_function                      (PurpleBuddy *buddy,
  62                                                         gboolean old_idle,
  63                                                         gboolean idle,
  64                                                         gpointer user_data)
  65 </programlisting>
  66   <para>
  67 Emitted when a buddy on your buddy list becomes idle.
  68   </para>
  69   <variablelist role="params">
  70   <varlistentry>
  71     <term><parameter>buddy</parameter>&#160;:</term>
  72     <listitem><simpara>The buddy whose idle status changed.</simpara></listitem>
  73   </varlistentry>
  74   <varlistentry>
  75     <term><parameter>old_idle</parameter>&#160;:</term>
  76     <listitem><simpara>Whether the buddy was idle.</simpara></listitem>
  77   </varlistentry>
  78   <varlistentry>
  79     <term><parameter>idle</parameter>&#160;:</term>
  80     <listitem><simpara>Whether the buddy is currently idle.</simpara></listitem>
  81   </varlistentry>
  82   <varlistentry>
  83     <term><parameter>user_data</parameter>&#160;:</term>
  84     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  85   </varlistentry>
  86   </variablelist>
  87 </refsect2>
  88
  89 <refsect2 id="blist-buddy-signed-on" role="signal">
  90  <title>The <literal>&quot;buddy-signed-on&quot;</literal> signal</title>
  91 <programlisting>
  92 void                user_function                      (PurpleBuddy *buddy,
  93                                                         gpointer user_data)
  94 </programlisting>
  95   <para>
  96 Emitted when a buddy on your buddy list signs on.
  97   </para>
  98   <variablelist role="params">
  99   <varlistentry>
 100     <term><parameter>buddy</parameter>&#160;:</term>
 101     <listitem><simpara>The buddy that signed on.</simpara></listitem>
 102   </varlistentry>
 103   <varlistentry>
 104     <term><parameter>user_data</parameter>&#160;:</term>
 105     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
 106   </varlistentry>
 107   </variablelist>
 108 </refsect2>
 109
 110 <refsect2 id="blist-buddy-signed-off" role="signal">
 111  <title>The <literal>&quot;buddy-signed-off&quot;</literal> signal</title>
 112 <programlisting>
 113 void                user_function                      (PurpleBuddy *buddy,
 114                                                         gpointer user_data)
 115 </programlisting>
 116   <para>
 117 Emitted when a buddy on your buddy list signs off.
 118   </para>
 119   <variablelist role="params">
 120   <varlistentry>
 121     <term><parameter>buddy</parameter>&#160;:</term>
 122     <listitem><simpara>The buddy that signed off.</simpara></listitem>
 123   </varlistentry>
 124   <varlistentry>
 125     <term><parameter>user_data</parameter>&#160;:</term>
 126     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
 127   </varlistentry>
 128   </variablelist>
 129 </refsect2>
 130
 131 <refsect2 id="blist-update-idle" role="signal">
 132  <title>The <literal>&quot;update-idle&quot;</literal> signal</title>
 133 <programlisting>
 134 void                user_function                      (gpointer user_data)
 135 </programlisting>
 136   <para>
 137 Emitted when the buddy list is refreshed and the idle times are updated.
 138   </para>
 139   <variablelist role="params">
 140   <varlistentry>
 141     <term><parameter>user_data</parameter>&#160;:</term>
 142     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
 143   </varlistentry>
 144   </variablelist>
 145 </refsect2>
 146
 147 <refsect2 id="blist-blist-node-extended-menu" role="signal">
 148  <title>The <literal>&quot;blist-node-extended-menu&quot;</literal> signal</title>
 149 <programlisting>
 150 void                user_function                      (PurpleBlistNode *node,
 151                                                         GList **menu,
 152                                                         gpointer user_data)
 153 </programlisting>
 154   <para>
 155 Emitted when a buddlist menu is being constructed <literal>menu</literal> is a pointer to a GList of PurpleMenuAction's allowing a plugin to add menu items.
 156   </para>
 157 </refsect2>
 158
 159 <refsect2 id="blist-blist-node-added" role="signal">
 160  <title>The <literal>&quot;blist-node-added&quot;</literal> signal</title>
 161 <programlisting>
 162 void                user_function                      (PurpleBlistNode *node,
 163                                                         gpointer user_data)
 164 </programlisting>
 165   <para>
 166 Emitted when a new blist node is added to the buddy list.
 167   </para>
 168 </refsect2>
 169
 170 <refsect2 id="blist-blist-node-removed" role="signal">
 171  <title>The <literal>&quot;blist-node-removed&quot;</literal> signal</title>
 172 <programlisting>
 173 void                user_function                      (PurpleBlistNode *node,
 174                                                         gpointer user_data)
 175 </programlisting>
 176   <para>
 177 Emitted when a blist node is removed from the buddy list.
 178   </para>
 179 </refsect2>
 180
 181 <refsect2 id="blist-buddy-icon-changed" role="signal">
 182  <title>The <literal>&quot;buddy-icon-changed&quot;</literal> signal</title>
 183 <programlisting>
 184 void                user_function                      (PurpleBuddy *buddy,
 185                                                         gpointer user_data)
 186 </programlisting>
 187   <para>
 188 Emitted when a buddy's icon is set.
 189   </para>
 190 </refsect2>
 191
 192 <refsect2 id="blist-blist-node-aliased" role="signal">
 193  <title>The <literal>&quot;blist-node-aliased&quot;</literal> signal</title>
 194 <programlisting>
 195 void                user_function                      (PurpleBlistNode *node,
 196                                                         const char *old_alias,
 197                                                         gpointer user_data)
 198 </programlisting>
 199   <para>
 200 Emitted when a blist node (buddy, chat, or contact) is aliased.
 201   </para>
 202 </refsect2>
 203
 204 <refsect2 id="blist-buddy-caps-changed" role="signal">
 205  <title>The <literal>&quot;buddy-caps-changed&quot;</literal> signal</title>
 206 <programlisting>
 207 void                user_function                      (PurpleBuddy *buddy,
 208                                                         PurpleMediaCaps newcaps,
 209                                                         PurpleMediaCaps oldcaps,
 210                                                         gpointer user_data)
 211 </programlisting>
 212   <para>
 213 Emitted when updating a buddy's media capabilities.
 214   </para>
 215   <variablelist role="params">
 216   <varlistentry>
 217     <term><parameter>buddy</parameter>&#160;:</term>
 218     <listitem><simpara>The buddy.</simpara></listitem>
 219   </varlistentry>
 220   <varlistentry>
 221     <term><parameter>newcaps</parameter>&#160;:</term>
 222     <listitem><simpara>.</simpara></listitem>
 223   </varlistentry>
 224   <varlistentry>
 225     <term><parameter>oldcaps</parameter>&#160;:</term>
 226     <listitem><simpara>.</simpara></listitem>
 227   </varlistentry>
 228   <varlistentry>
 229     <term><parameter>user_data</parameter>&#160;:</term>
 230     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
 231   </varlistentry>
 232   </variablelist>
 233 </refsect2>
 234
 235 <refsect2 id="blist-ui-caps-changed" role="signal">
 236  <title>The <literal>&quot;ui-caps-changed&quot;</literal> signal</title>
 237 <programlisting>
 238 void                user_function                      (PurpleMediaCaps newcaps,
 239                                                         PurpleMediaCaps oldcaps,
 240                                                         gpointer user_data)
 241 </programlisting>
 242   <para>
 243 Emitted when updating the media capabilities of the UI.
 244   </para>
 245   <variablelist role="params">
 246   <varlistentry>
 247     <term><parameter>newcaps</parameter>&#160;:</term>
 248     <listitem><simpara>.</simpara></listitem>
 249   </varlistentry>
 250   <varlistentry>
 251     <term><parameter>oldcaps</parameter>&#160;:</term>
 252     <listitem><simpara>.</simpara></listitem>
 253   </varlistentry>
 254   <varlistentry>
 255     <term><parameter>user_data</parameter>&#160;:</term>
 256     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
 257   </varlistentry>
 258   </variablelist>
 259 </refsect2>
 260
 261 </refsect1>
 262
 263 </chapter>