view doc/blist-signals.dox @ 9213:99abaef7ed34

[gaim-migrate @ 10008] Here's a first stab at /help Still some things that need work. Notice that help is listed twice, etc. I think I'll change it to make it automaticly tell you the args, instead of putting them in the help string. Also there's the question of if help strings should be considered html or plain text. (If plain text, we need to run gaim_escape_html on it in /help.) committer: Tailor Script <[e-mail]>

/** @page blist-signals Buddy List Signals

 @signals
  @signal buddy-away
  @signal buddy-back
  @signal buddy-idle
  @signal buddy-unidle
  @signal buddy-signed-on
  @signal buddy-signed-off
  @signal update-idle
  @signal blist-node-extended-menu
 @endsignals

 <hr>

 @signaldef buddy-away
  @signalproto
void (*buddy_away)(struct buddy *buddy);
  @endsignalproto
  @signaldesc
   Emitted when a buddy on your buddy list goes away.
  @param buddy The buddy that went away.
 @endsignaldef

 @signaldef buddy-back
  @signalproto
void (*buddy_back)(struct buddy *buddy);
  @endsignalproto
  @signaldesc
   Emitted when a buddy on your buddy list comes back from being away.
  @param buddy The buddy that came back from being away.
 @endsignaldef

 @signaldef buddy-idle
  @signalproto
void (*buddy_idle)(struct buddy *buddy);
  @endsignalproto
  @signaldesc
   Emitted when a buddy on your buddy list becomes idle.
  @param buddy The buddy that became idle.
 @endsignaldef

 @signaldef buddy-unidle
  @signalproto
void (*buddy_unidle)(struct buddy *buddy);
  @endsignalproto
  @signaldesc
   Emitted when a buddy on your buddy list returns from being idle.
  @param buddy The buddy that returned from being idle.
 @endsignaldef

 @signaldef buddy-idle-updated
  @signalproto
void (*buddy_idle_updated)(struct buddy *buddy);
  @endsignalproto
  @signaldesc
   Emitted when a buddy's idle time changes. The exceptions are when the
   buddy goes from being idle to being unidle, or from unidle to idle.
  @param buddy The buddy whose idle time changed.
 @endsignaldef

 @signaldef buddy-signed-on
  @signalproto
void (*buddy_signed_on)(struct buddy *buddy);
  @endsignalproto
  @signaldesc
   Emitted when a buddy on your buddy list signs on.
  @param buddy The buddy that signed on.
 @endsignaldef

 @signaldef buddy-signed-off
  @signalproto
void (*buddy_signed_off)(struct buddy *buddy);
  @endsignalproto
  @signaldesc
   Emitted when a buddy on your buddy list signs off.
  @param buddy The buddy that signed off.
 @endsignaldef

 @signaldef update-idle
  @signalproto
void (*update_idle)();
  @endsignalproto
  @signaldesc
   Emitted when the buddy list is refreshed and the idle times are updated.
 @endsignaldef

 @signaldef blist-node-extended-menu
  @signalproto
void (*blist_node_extended_menu)(GaimBlistNode *node, GList **menu)
  @endsignalproto
  @signaldesc
   Emitted when a buddlist menu is being constructed @a menu is a pointer to
   a GList of GaimBlistNodeAction's allowing a plugin to add menu items
 @endsignaldef

 */
// vim: syntax=c tw=75 et