Mercurial > pidgin.yaz

annotate doc/notify-signals.dox @ 25532:1e92ac5586d9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
propagate from branch 'im.pidgin.pidgin' (head b195e262642015df66e36d33e9dd16ecae5df9d5) to branch 'im.pidgin.pidgin.yaz' (head 1ad0829f976f1cce3dce20aa96a958e97caaa748)
author Yoshiki Yazawa <yaz@honeyplanet.jp>
date Wed, 11 Jul 2007 05:26:10 +0000
parents 2177a11e169d
children cb91bb07eeff
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18357
2177a11e169d Add links to the signal documents in the API documents.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
1 /** @page notify-signals Notification Signals
12129
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: 15266
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: 15266
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: 15266
diff changeset
15 If adding a PurpleNotifyUserInfoEntry, be sure not to free it -- PurpleNotifyUserInfo assumes responsibility for its objects.
15266
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: 15266
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