Mercurial > pidgin
annotate doc/notify-signals.dox @ 18402:238086459dc4
propagate from branch 'im.pidgin.pidgin' (head 98416e917a1165a4df7eb5839840348ff4c17bf2)
to branch 'org.maemo.garage.pidgin.pidgin.about-menu-icon' (head d8a42ed758757ffa01f3dbf8dd6ec2a33d4b3891)
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Sun, 01 Jul 2007 03:15:43 +0000 |
parents | 2177a11e169d |
children | cb91bb07eeff |
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 | 2 |
3 @signals | |
4 @signal displaying-userinfo | |
5 @endsignals | |
6 | |
7 @signaldef displaying-userinfo | |
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 | 10 @endsignalproto |
11 @signaldesc | |
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 | 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 | 19 @endsignaldef |
20 | |
21 */ | |
22 // vim: syntax=c tw=75 et |