annotate doc/notify-signals.dox @ 13190:60b863ecd89b

[gaim-migrate @ 15553] perl scripts can use signal priority now. Also it's always bothered me that the debug and signal stuff was just stuck at the bottom of Gaim.xs so I've moved them to their own files, committer: Tailor Script <tailor@pidgin.im>
author Etan Reisner <pidgin@unreliablesource.net>
date Wed, 08 Feb 2006 23:13:56 +0000
parents 216988c717da
children faa6afdcea39
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
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
9 void (*displaying_userinfo)(GaimAccount *account, const char *who, char **infotext);
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.
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
13 @a infotext is a pointer to a string, so a plugin can replace the text that
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
14 will be displayed.
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
15 @note
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
16 Make sure to free @a *infotext before you replace it!
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
17 @param account The account on which the info was obtained.
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
18 @param who The screen name of the user whose info is to be displayed.
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
19 @param infotext A pointer to the userinfo text to be displayed.
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
20 @endsignaldef
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 */
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
23 // vim: syntax=c tw=75 et