view doc/blist-signals.dox @ 18916:0f46f13c0805

Proposed "attention" API, a generalization of zaps (MySpaceIM), buzzes (Yahoo), and nudges (MSN). Adds a PurpleAttentionType struct to prpl.h, which is used to describe the the attention command (some protocols, notably MySpaceIM, support more than one). Uses two reserved fields in PurplePluginProtocolInfo, one function for sending an attention command, another for getting the possible attention commands (similar to status_types). Adds serv_got_attention() to server.c, similar to serv_got_im(), used to notify of incoming or outgoing attention notices.

/** @page blist-signals Buddy List Signals

 @signals
  @signal buddy-status-changed
  @signal buddy-idle-changed
  @signal buddy-signed-on
  @signal buddy-signed-off
  @signal update-idle
  @signal blist-node-extended-menu
  @signal buddy-added
  @signal buddy-removed
  @signal buddy-icon-changed
  @signal blist-node-aliased
 @endsignals

 <hr>

 @signaldef buddy-status-changed
  @signalproto
void (*buddy_away)(PurpleBuddy *buddy, PurpleStatus *old_status, PurpleStatus *status);
  @endsignalproto
  @signaldesc
   Emitted when a buddy on your buddy list goes away.
  @param buddy      The buddy whose status changed.
  @param old_status The status that the buddy just changed from.
  @param status     The status that the buddy just changed to.
 @endsignaldef

 @signaldef buddy-idle-changed
  @signalproto
void (*buddy_idle)(PurpleBuddy *buddy, gboolean old_idle, gboolean idle);
  @endsignalproto
  @signaldesc
   Emitted when a buddy on your buddy list becomes idle.
  @param buddy    The buddy whose idle status changed.
  @param old_idle Whether the buddy was idle.
  @param idle     Whether the buddy is currently idle.
 @endsignaldef

 @signaldef buddy-signed-on
  @signalproto
void (*buddy_signed_on)(PurpleBuddy *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)(PurpleBuddy *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)(PurpleBlistNode *node, GList **menu)
  @endsignalproto
  @signaldesc
   Emitted when a buddlist menu is being constructed @a menu is a pointer to
   a GList of PurpleBlistNodeAction's allowing a plugin to add menu items
 @endsignaldef

 @signaldef buddy-added
  @signalproto
void (*buddy_added)(PurpleBuddy *buddy)
  @endsignalproto
  @signaldesc
   Emitted when a new buddy is added to the buddy list.
  @endsignaldef

 @signaldef buddy-icon-changed
  @signalproto
void (*buddy_icon_changed)(PurpleBuddy *buddy)
  @endsignalproto
  @signaldesc
   Emitted when a buddy's icon is set.
  @endsignaldef

 @signaldef buddy-removed
  @signalproto
void (*buddy_removed)(PurpleBuddy *buddy)
  @endsignalproto
  @signaldesc
   Emitted when a buddy is removed from the buddy list.
  @endsignaldef

 @signaldef blist-node-aliased
  @signalproto
void (*blist_node_aliased)(PurpleBlistNode *node, const char *old_alias)
  @endsignalproto
  @signaldesc
   Emitted when a blist node (buddy, chat, or contact) is aliased.
  @endsignaldef

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