doc/notify-signals.dox@0027732ddb26 (annotated)
doc/notify-signals.dox
Sun, 22 Jul 2007 01:28:19 +0000
- author
- Eric Polino <aluink@pidgin.im>
- date
- Sun, 22 Jul 2007 01:28:19 +0000
- branch
- soc.2007.finchfeat
- changeset 19307
- 0027732ddb26
- parent 18412
- 6873322c380f
- child 18976
- fcf071533791
- permissions
- -rw-r--r--
propagate from branch 'tmpbranch' (head 99adc2a159d591428565c43f8121b7f0d5cdf6f6)
to branch 'im.pidgin.soc.2007.finchfeat' (head 4c0284a98465984103fcdcdf66fce684482034ce)
|
18412
6873322c380f
Add links to the signal documents in the API documents.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
16244
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 | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
15327
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. | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
15327
diff
changeset
|
13 | @a user_info can be manipulated via the PurpleNotifyUserInfo API in notify.c. |
| 12129 | 14 | @note |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
15327
diff
changeset
|
15 | If adding a PurpleNotifyUserInfoEntry, be sure not to free it -- PurpleNotifyUserInfo assumes responsibility for its objects. |
|
15327
ec403c2abb8a
[gaim-migrate @ 18055]
Evan Schoenberg <evands@pidgin.im>
parents:
12129
diff
changeset
|
16 | @param account The account on which the info was obtained. |
|
ec403c2abb8a
[gaim-migrate @ 18055]
Evan Schoenberg <evands@pidgin.im>
parents:
12129
diff
changeset
|
17 | @param who The screen name of the user whose info is to be displayed. |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
15327
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 |
