doc/notify-signals.dox

Sun, 29 Apr 2007 23:34:04 +0000

author
Richard Laager <rlaager@pidgin.im>
date
Sun, 29 Apr 2007 23:34:04 +0000
changeset 16740
c95b1a276ea1
parent 16244
be35cbf49dfb
child 18412
6873322c380f
permissions
-rw-r--r--

Document the image-deleting signal.

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

mercurial