Mercurial > pidgin.yaz

comparison doc/notify-signals.dox @ 15266:faa6afdcea39

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[gaim-migrate @ 18055] doxygen documentation update for the displaying-userinfo signal committer: Tailor Script <tailor@pidgin.im>
author Evan Schoenberg <evan.s@dreskin.net>
date Tue, 26 Dec 2006 02:47:13 +0000
parents 216988c717da
children 8cf53d7a0887
comparison
equal deleted inserted replaced
15265:0a41469d6440 15266:faa6afdcea39
4 @signal displaying-userinfo 4 @signal displaying-userinfo
5 @endsignals 5 @endsignals
6 6
7 @signaldef displaying-userinfo 7 @signaldef displaying-userinfo
8 @signalproto 8 @signalproto
9 void (*displaying_userinfo)(GaimAccount *account, const char *who, char **infotext); 9 void (*displaying_userinfo)(GaimAccount *account, const char *who, GaimNotifyUserInfo *user_info);
10 @endsignalproto 10 @endsignalproto
11 @signaldesc 11 @signaldesc
12 Emitted before userinfo is handed to the UI to display. 12 Emitted before userinfo is handed to the UI to display.
13 @a infotext is a pointer to a string, so a plugin can replace the text that 13 @a user_info can be manipulated via the GaimNotifyUserInfo API in notify.c.
14 will be displayed.
15 @note 14 @note
16 Make sure to free @a *infotext before you replace it! 15 If adding a GaimNotifyUserInfoEntry, be sure not to free it -- GaimNotifyUserInfo assumes responsibility for its objects.
17 @param account The account on which the info was obtained. 16 @param account The account on which the info was obtained.
18 @param who The screen name of the user whose info is to be displayed. 17 @param who The screen name of the user whose info is to be displayed.
19 @param infotext A pointer to the userinfo text to be displayed. 18 @param user_info The information to be displayed, as GaimNotifyUserInfoEntry objects
20 @endsignaldef 19 @endsignaldef
21 20
22 */ 21 */
23 // vim: syntax=c tw=75 et 22 // vim: syntax=c tw=75 et