annotate doc/gtkblist-signals.dox @ 16341:786edf5e2144

The core portion of the migration code. This is implemented as I described in my e-mail a while back. If we have ~/.gaim and not ~/.purple (or we have ~/.purple, but the "migrating" file exists, indicating an incomplete previous migration), we copy all the files from ~/.gaim to ~/.purple and move and symlink directories, except for plugins and icons. For icons, we move and symlink any subdirectories, as a special case for the Album plugin (written by me). For this to work, it needs to be called by the UIs. Also, the icon migration code is not included in this commit, so I highly recommend you not test this on your main .gaim directory if you want a clean migration.

/** @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