Mercurial > pidgin

annotate doc/notify-signals.dox @ 18968:1677ead39ee3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
- Add purple_ssl_strerror for handy error description power!
author William Ehlhardt <williamehlhardt@gmail.com>
date Wed, 27 Jun 2007 04:56:21 +0000
parents 8cf53d7a0887
children 2177a11e169d
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
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 15265
diff changeset
9 void (*displaying_userinfo)(PurpleAccount *account, const char *who, PurpleNotifyUserInfo *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.
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 15265
diff changeset
13 @a user_info can be manipulated via the PurpleNotifyUserInfo API in notify.c.
12129
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
14 @note
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 15265
diff changeset
15 If adding a PurpleNotifyUserInfoEntry, be sure not to free it -- PurpleNotifyUserInfo assumes responsibility for its objects.
15265
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.
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 15265
diff changeset
18 @param user_info The information to be displayed, as PurpleNotifyUserInfoEntry 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