annotate doc/notify-signals.dox @ 15439:a415922e2882

merge of '8f5c72b9dbcf628f35e4674469f97b34f9c6fa2c' and 'e082ba7b9cfaf0fef0531d0fe9b54af7831f75df'
author Ethan Blanton <elb@pidgin.im>
date Sun, 28 Jan 2007 01:24:15 +0000
parents faa6afdcea39
children 8cf53d7a0887
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12129
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
1 /** @page conversation-signals Notification Signals
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
2
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
3 @signals
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
4 @signal displaying-userinfo
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
5 @endsignals
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
6
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
7 @signaldef displaying-userinfo
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
8 @signalproto
15266
faa6afdcea39 [gaim-migrate @ 18055]
Evan Schoenberg <evan.s@dreskin.net>
parents: 12129
diff changeset
9 void (*displaying_userinfo)(GaimAccount *account, const char *who, GaimNotifyUserInfo *user_info);
12129
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
10 @endsignalproto
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
11 @signaldesc
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
12 Emitted before userinfo is handed to the UI to display.
15266
faa6afdcea39 [gaim-migrate @ 18055]
Evan Schoenberg <evan.s@dreskin.net>
parents: 12129
diff changeset
13 @a user_info can be manipulated via the GaimNotifyUserInfo API in notify.c.
12129
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
14 @note
15266
faa6afdcea39 [gaim-migrate @ 18055]
Evan Schoenberg <evan.s@dreskin.net>
parents: 12129
diff changeset
15 If adding a GaimNotifyUserInfoEntry, be sure not to free it -- GaimNotifyUserInfo assumes responsibility for its objects.
faa6afdcea39 [gaim-migrate @ 18055]
Evan Schoenberg <evan.s@dreskin.net>
parents: 12129
diff changeset
16 @param account The account on which the info was obtained.
faa6afdcea39 [gaim-migrate @ 18055]
Evan Schoenberg <evan.s@dreskin.net>
parents: 12129
diff changeset
17 @param who The screen name of the user whose info is to be displayed.
faa6afdcea39 [gaim-migrate @ 18055]
Evan Schoenberg <evan.s@dreskin.net>
parents: 12129
diff changeset
18 @param user_info The information to be displayed, as GaimNotifyUserInfoEntry objects
12129
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
19 @endsignaldef
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
20
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
21 */
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
22 // vim: syntax=c tw=75 et