view doc/notify-signals.dox @ 18701:97f088385a75

propagate from branch 'im.pidgin.pidgin' (head 53b8831e57f625eca0980aca94f04416b32bcd8f) to branch 'im.pidgin.soc.2007.xmpp' (head 0a04b5234fe2884ea9150e5dcdd4c47f016eb926)

/** @page notify-signals Notification Signals

 @signals
  @signal displaying-userinfo
 @endsignals

 @signaldef displaying-userinfo
  @signalproto
void (*displaying_userinfo)(PurpleAccount *account, const char *who, PurpleNotifyUserInfo *user_info);
  @endsignalproto
  @signaldesc
   Emitted before userinfo is handed to the UI to display.
   @a user_info can be manipulated via the PurpleNotifyUserInfo API in notify.c.
  @note
    If adding a PurpleNotifyUserInfoEntry, be sure not to free it -- PurpleNotifyUserInfo assumes responsibility for its objects.
  @param account   The account on which the info was obtained.
  @param who       The screen name of the user whose info is to be displayed.
  @param user_info The information to be displayed, as PurpleNotifyUserInfoEntry objects
 @endsignaldef

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