Mercurial > pidgin.yaz
annotate doc/notify-signals.dox @ 20335:5defb0546059
applied changes from c848ad4c20988b5dac9ac164455d3ba2d7307230
through 9d35dde0c779cca73548172223ba557f27d61882
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Fri, 19 Oct 2007 18:36:08 +0000 |
parents | cb91bb07eeff |
children | e0613cf8c493 |
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 | |
18675
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
5 @signal displaying-email-notification |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
6 @signal displaying-emails-notification |
12129 | 7 @endsignals |
8 | |
9 @signaldef displaying-userinfo | |
10 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
15266
diff
changeset
|
11 void (*displaying_userinfo)(PurpleAccount *account, const char *who, PurpleNotifyUserInfo *user_info); |
12129 | 12 @endsignalproto |
13 @signaldesc | |
14 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
|
15 @a user_info can be manipulated via the PurpleNotifyUserInfo API in notify.c. |
12129 | 16 @note |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
15266
diff
changeset
|
17 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
|
18 @param account The account on which the info was obtained. |
faa6afdcea39
[gaim-migrate @ 18055]
Evan Schoenberg <evan.s@dreskin.net>
parents:
12129
diff
changeset
|
19 @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
|
20 @param user_info The information to be displayed, as PurpleNotifyUserInfoEntry objects |
12129 | 21 @endsignaldef |
22 | |
18675
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
23 @signaldef displaying-email-notification |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
24 @signalproto |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
25 void (*displaying_email_notification)(const char *subject, |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
26 const char *from, |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
27 const char *to, |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
28 const char *url); |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
29 @endsignalproto |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
30 @signaldesc |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
31 Emitted before email notification is handed to the UI to display. |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
32 @param subject Subject of email being notified of. |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
33 @param from Who the email is from. |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
34 @param to Who the email is to. |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
35 @param url A url to view the email. |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
36 @endsignaldef |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
37 |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
38 @signaldef displaying-emails-notification |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
39 @signalproto |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
40 void (*displaying_emails_notification)(const char **subjects, |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
41 const char **froms, |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
42 const char **tos, |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
43 const char **urls, |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
44 guint count); |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
45 @endsignalproto |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
46 @signaldesc |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
47 Emitted before notification of multiple emails is handed to the UI to display. |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
48 @param subjects Subjects of emails being notified of. |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
49 @param froms Who the emails are from. |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
50 @param tos Who the emails are to. |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
51 @param urls The urls to view the emails. |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
52 @param count Number of emails being notified of. |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
53 @endsignaldef |
cb91bb07eeff
Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents:
18357
diff
changeset
|
54 |
12129 | 55 */ |
56 // vim: syntax=c tw=75 et |