doc/gtkblist-signals.dox

   1 /** @page gtkblist-signals GtkBlist Signals
   2
   3  @signals
   4   @signal gtkblist-hiding
   5   @signal gtkblist-unhiding
   6   @signal gtkblist-created
   7   @signal drawing-tooltip
   8  @endsignals
   9
  10  <hr>
  11
  12  @signaldef gtkblist-hiding
  13   @signalproto
  14 void (*gtkblist-hiding)(PurpleBuddyList *blist);
  15   @endsignalproto
  16   @signaldesc
  17    Emitted when the buddy list is about to be hidden.
  18   @param blist The buddy list.
  19  @endsignaldef
  20
  21  @signaldef gtkblist-unhiding
  22   @signalproto
  23 void (*gtkblist-unhiding)(PurpleBuddyList *blist);
  24   @endsignalproto
  25   @signaldesc
  26    Emitted when the buddy list is about to be unhidden.
  27   @param blist The buddy list.
  28  @endsignaldef
  29
  30  @signaldef gtkblist-created
  31   @signalproto
  32 void (*gtkblist-created)(PurpleBuddyList *blist);
  33   @endsignalproto
  34   @signaldesc
  35    Emitted when the buddy list is created.
  36   @param blist The buddy list.
  37  @endsignaldef
  38
  39  @signaldef drawing-tooltip
  40   @signalproto
  41 void (*drawing-tooltip)(PurpleBlistNode *node, GString *text, gboolean full);
  42   @endsignalproto
  43   @signaldesc
  44    Emitted just before a tooltip is displayed.
  45    @a text is a standard GString, so the plugin can modify the text that
  46    will be displayed.
  47   @note
  48    Make sure to free @a *text before you replace it!
  49   @param node The blist node for the tooltip.
  50   @param text A pointer to the text that will be displayed.
  51   @param full Whether we're doing a full tooltip for the priority buddy or
  52               a compact tooltip for a non-priority buddy.
  53  @endsignaldef
  54 */
  55 // vim: syntax=c tw=75 et