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