doc/blist-signals.dox

   1 /** @page blist-signals Buddy List Signals
   2
   3  @signals
   4   @signal buddy-status-changed
   5   @signal buddy-idle-changed
   6   @signal buddy-signed-on
   7   @signal buddy-signed-off
   8   @signal update-idle
   9   @signal blist-node-extended-menu
  10   @signal buddy-added
  11   @signal buddy-removed
  12   @signal buddy-icon-changed
  13   @signal blist-node-aliased
  14   @signal buddy-caps-changed
  15   @signal ui-caps-changed
  16  @endsignals
  17
  18  @see blist.h
  19
  20  <hr>
  21
  22  @signaldef buddy-status-changed
  23   @signalproto
  24 void (*buddy_away)(PurpleBuddy *buddy, PurpleStatus *old_status, PurpleStatus *status);
  25   @endsignalproto
  26   @signaldesc
  27    Emitted when a buddy on your buddy list goes away.
  28   @param buddy      The buddy whose status changed.
  29   @param old_status The status that the buddy just changed from.
  30   @param status     The status that the buddy just changed to.
  31  @endsignaldef
  32
  33  @signaldef buddy-idle-changed
  34   @signalproto
  35 void (*buddy_idle)(PurpleBuddy *buddy, gboolean old_idle, gboolean idle);
  36   @endsignalproto
  37   @signaldesc
  38    Emitted when a buddy on your buddy list becomes idle.
  39   @param buddy    The buddy whose idle status changed.
  40   @param old_idle Whether the buddy was idle.
  41   @param idle     Whether the buddy is currently idle.
  42  @endsignaldef
  43
  44  @signaldef buddy-signed-on
  45   @signalproto
  46 void (*buddy_signed_on)(PurpleBuddy *buddy);
  47   @endsignalproto
  48   @signaldesc
  49    Emitted when a buddy on your buddy list signs on.
  50   @param buddy The buddy that signed on.
  51  @endsignaldef
  52
  53  @signaldef buddy-signed-off
  54   @signalproto
  55 void (*buddy_signed_off)(PurpleBuddy *buddy);
  56   @endsignalproto
  57   @signaldesc
  58    Emitted when a buddy on your buddy list signs off.
  59   @param buddy The buddy that signed off.
  60  @endsignaldef
  61
  62  @signaldef update-idle
  63   @signalproto
  64 void (*update_idle)();
  65   @endsignalproto
  66   @signaldesc
  67    Emitted when the buddy list is refreshed and the idle times are updated.
  68  @endsignaldef
  69
  70  @signaldef blist-node-extended-menu
  71   @signalproto
  72 void (*blist_node_extended_menu)(PurpleBlistNode *node, GList **menu)
  73   @endsignalproto
  74   @signaldesc
  75    Emitted when a buddlist menu is being constructed @a menu is a pointer to
  76    a GList of PurpleBlistNodeAction's allowing a plugin to add menu items
  77  @endsignaldef
  78
  79  @signaldef blist-node-added
  80   @signalproto
  81 void (*blist_node_added)(PurpleBlistNode *node)
  82   @endsignalproto
  83   @signaldesc
  84    Emitted when a new blist node is added to the buddy list.
  85  @endsignaldef
  86
  87  @signaldef blist-node-removed
  88   @signalproto
  89 void (*blist_node_removed)(PurpleBlistNode *node)
  90   @endsignalproto
  91   @signaldesc
  92    Emitted when a blist node is removed from the buddy list.
  93  @endsignaldef
  94
  95  @signaldef buddy-added
  96   @signalproto
  97 void (*buddy_added)(PurpleBuddy *buddy)
  98   @endsignalproto
  99   @signaldesc
 100    Emitted when a new buddy is added to the buddy list.
 101   @deprecated Use blist-node-added instead.
 102  @endsignaldef
 103
 104  @signaldef buddy-removed
 105   @signalproto
 106 void (*buddy_removed)(PurpleBuddy *buddy)
 107   @endsignalproto
 108   @signaldesc
 109    Emitted when a buddy is removed from the buddy list.
 110   @deprecated Use blist-node-removed instead.
 111  @endsignaldef
 112
 113  @signaldef buddy-icon-changed
 114   @signalproto
 115 void (*buddy_icon_changed)(PurpleBuddy *buddy)
 116   @endsignalproto
 117   @signaldesc
 118    Emitted when a buddy's icon is set.
 119   @endsignaldef
 120
 121  @signaldef blist-node-aliased
 122   @signalproto
 123 void (*blist_node_aliased)(PurpleBlistNode *node, const char *old_alias)
 124   @endsignalproto
 125   @signaldesc
 126    Emitted when a blist node (buddy, chat, or contact) is aliased.
 127   @endsignaldef
 128
 129  @signaldef buddy-caps-changed
 130   @signalproto
 131 void (*buddy_caps_changed)(PurpleBuddy *buddy, PurpleMediaCaps newcaps,
 132     PurpleMediaCaps oldcaps)
 133   @endsignalproto
 134   @signaldesc
 135     Emitted when updating a buddy's media capabilities.
 136   @param buddy    The buddy
 137   @param newcaps
 138   @param oldcaps
 139   @since 2.7.0
 140  @endsignaldef
 141
 142  @signaldef ui-caps-changed
 143   @signalproto
 144 void (*ui_caps_changed)(PurpleMediaCaps newcaps, PurpleMediaCaps oldcaps)
 145   @endsignalproto
 146   @signaldesc
 147     Emitted when updating the media capabilities of the UI.
 148   @param newcaps
 149   @param oldcaps
 150   @since 2.7.0
 151  @endsignaldef
 152
 153  */
 154 // vim: syntax=c.doxygen tw=75 et