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   @signal drawing-buddy
   9  @endsignals
  10
  11  @see gtkblist.h
  12
  13  <hr>
  14
  15  @signaldef gtkblist-hiding
  16   @signalproto
  17 void (*gtkblist-hiding)(PurpleBuddyList *blist);
  18   @endsignalproto
  19   @signaldesc
  20    Emitted when the buddy list is about to be hidden.
  21   @param blist The buddy list.
  22  @endsignaldef
  23
  24  @signaldef gtkblist-unhiding
  25   @signalproto
  26 void (*gtkblist-unhiding)(PurpleBuddyList *blist);
  27   @endsignalproto
  28   @signaldesc
  29    Emitted when the buddy list is about to be unhidden.
  30   @param blist The buddy list.
  31  @endsignaldef
  32
  33  @signaldef gtkblist-created
  34   @signalproto
  35 void (*gtkblist-created)(PurpleBuddyList *blist);
  36   @endsignalproto
  37   @signaldesc
  38    Emitted when the buddy list is created.
  39   @param blist The buddy list.
  40  @endsignaldef
  41
  42  @signaldef drawing-tooltip
  43   @signalproto
  44 void (*drawing-tooltip)(PurpleBlistNode *node, GString *text, gboolean full);
  45   @endsignalproto
  46   @signaldesc
  47    Emitted just before a tooltip is displayed.
  48    @a text is a standard GString, so the plugin can modify the text that
  49    will be displayed.
  50   @note
  51    Make sure to free @a *text before you replace it!
  52   @param node The blist node for the tooltip.
  53   @param text A pointer to the text that will be displayed.
  54   @param full Whether we're doing a full tooltip for the priority buddy or
  55               a compact tooltip for a non-priority buddy.
  56  @endsignaldef
  57
  58  @signaldef drawing-buddy
  59   @signalproto
  60 char *(*drawing-buddy)(PurpleBuddy *buddy);
  61   @endsignalproto
  62   @signaldesc
  63    Emitted to allow plugins to handle markup within a buddy's name or to
  64    override the default of no formatting for names shown in the buddy list.
  65    @param buddy A pointer to the PurpleBuddy that will be displayed.
  66    @return The text to display (must be allocated), or @c NULL if no
  67            changes to the default behavior are desired.
  68  @endsignaldef
  69 */
  70 // vim: syntax=c.doxygen tw=75 et