Mercurial > pidgin
comparison doc/notify-signals.dox @ 12129:216988c717da
[gaim-migrate @ 14429]
SF Patch #1353745 from bsponline (Ka-Hing Cheung)
"Adds a signal to fire an event before userinfo/profile
is shown, so that a plugin can modify it."
I renamed it from receiving-userinfo to displaying-userinfo and documented it.
committer: Tailor Script <tailor@pidgin.im>
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Fri, 18 Nov 2005 12:44:07 +0000 |
parents | |
children | faa6afdcea39 |
comparison
equal
deleted
inserted
replaced
12128:34deaeeb5d42 | 12129:216988c717da |
---|---|
1 /** @page conversation-signals Notification Signals | |
2 | |
3 @signals | |
4 @signal displaying-userinfo | |
5 @endsignals | |
6 | |
7 @signaldef displaying-userinfo | |
8 @signalproto | |
9 void (*displaying_userinfo)(GaimAccount *account, const char *who, char **infotext); | |
10 @endsignalproto | |
11 @signaldesc | |
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 | |
14 will be displayed. | |
15 @note | |
16 Make sure to free @a *infotext before you replace it! | |
17 @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. | |
19 @param infotext A pointer to the userinfo text to be displayed. | |
20 @endsignaldef | |
21 | |
22 */ | |
23 // vim: syntax=c tw=75 et |