view doc/notify-signals.dox @ 12848:d26e3314c650

[gaim-migrate @ 15198] Make the options say what the plugin is supposed to do and then make the plugin do what the options say it does. committer: Tailor Script <tailor@pidgin.im>
author Richard Laager <rlaager@wiktel.com>
date Thu, 12 Jan 2006 06:12:03 +0000
parents 216988c717da
children faa6afdcea39
line wrap: on
line source

/** @page conversation-signals Notification Signals

 @signals
  @signal displaying-userinfo
 @endsignals

 @signaldef displaying-userinfo
  @signalproto
void (*displaying_userinfo)(GaimAccount *account, const char *who, char **infotext);
  @endsignalproto
  @signaldesc
   Emitted before userinfo is handed to the UI to display.
   @a infotext is a pointer to a string, so a plugin can replace the text that
   will be displayed.
  @note
   Make sure to free @a *infotext before you replace it!
  @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 infotext A pointer to the userinfo text to be displayed.
 @endsignaldef

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