view doc/gtkblist-signals.dox @ 16810:02867a434634

merge of '1059632ecbace7c85e35918f6c6d139494fdc250' and '9e13ca8ea260cdda26dfdb3f4b7e3ff1d7578b4a'
author Luke Schierer <lschiere@pidgin.im>
date Thu, 03 May 2007 14:29:04 +0000
parents 8cf53d7a0887
children e0613cf8c493
line wrap: on
line source

/** @page gtkblist-signals GtkBlist Signals

 @signals
  @signal gtkblist-hiding
  @signal gtkblist-unhiding
  @signal gtkblist-created
  @signal drawing-tooltip
 @endsignals

 <hr>

 @signaldef gtkblist-hiding
  @signalproto
void (*gtkblist-hiding)(PurpleBuddyList *blist);
  @endsignalproto
  @signaldesc
   Emitted when the buddy list is about to be hidden.
  @param blist The buddy list.
 @endsignaldef

 @signaldef gtkblist-unhiding
  @signalproto
void (*gtkblist-unhiding)(PurpleBuddyList *blist);
  @endsignalproto
  @signaldesc
   Emitted when the buddy list is about to be unhidden.
  @param blist The buddy list.
 @endsignaldef

 @signaldef gtkblist-created
  @signalproto
void (*gtkblist-created)(PurpleBuddyList *blist);
  @endsignalproto
  @signaldesc
   Emitted when the buddy list is created.
  @param blist The buddy list.
 @endsignaldef

 @signaldef drawing-tooltip
  @signalproto
void (*drawing-tooltip)(PurpleBlistNode *node, GString *text, gboolean full);
  @endsignalproto
  @signaldesc
   Emitted just before a tooltip is displayed.
   @a text is a standard GString, so the plugin can modify the text that
   will be displayed.
  @note
   Make sure to free @a *text before you replace it!
  @param node The blist node for the tooltip.
  @param text A pointer to the text that will be displayed.
  @param full Whether we're doing a full tooltip for the priority buddy or
              a compact tooltip for a non-priority buddy.
 @endsignaldef
*/
// vim: syntax=c tw=75 et