comparison doc/notify-signals.dox @ 18675:cb91bb07eeff

Email notification signals from charkins. Fixes #1324
author Sean Egan <seanegan@gmail.com>
date Sat, 28 Jul 2007 05:30:19 +0000
parents 2177a11e169d
children e0613cf8c493
comparison
equal deleted inserted replaced
18674:7c8321023ae5 18675:cb91bb07eeff
1 /** @page notify-signals Notification Signals 1 /** @page notify-signals Notification Signals
2 2
3 @signals 3 @signals
4 @signal displaying-userinfo 4 @signal displaying-userinfo
5 @signal displaying-email-notification
6 @signal displaying-emails-notification
5 @endsignals 7 @endsignals
6 8
7 @signaldef displaying-userinfo 9 @signaldef displaying-userinfo
8 @signalproto 10 @signalproto
9 void (*displaying_userinfo)(PurpleAccount *account, const char *who, PurpleNotifyUserInfo *user_info); 11 void (*displaying_userinfo)(PurpleAccount *account, const char *who, PurpleNotifyUserInfo *user_info);
16 @param account The account on which the info was obtained. 18 @param account The account on which the info was obtained.
17 @param who The screen name of the user whose info is to be displayed. 19 @param who The screen name of the user whose info is to be displayed.
18 @param user_info The information to be displayed, as PurpleNotifyUserInfoEntry objects 20 @param user_info The information to be displayed, as PurpleNotifyUserInfoEntry objects
19 @endsignaldef 21 @endsignaldef
20 22
23 @signaldef displaying-email-notification
24 @signalproto
25 void (*displaying_email_notification)(const char *subject,
26 const char *from,
27 const char *to,
28 const char *url);
29 @endsignalproto
30 @signaldesc
31 Emitted before email notification is handed to the UI to display.
32 @param subject Subject of email being notified of.
33 @param from Who the email is from.
34 @param to Who the email is to.
35 @param url A url to view the email.
36 @endsignaldef
37
38 @signaldef displaying-emails-notification
39 @signalproto
40 void (*displaying_emails_notification)(const char **subjects,
41 const char **froms,
42 const char **tos,
43 const char **urls,
44 guint count);
45 @endsignalproto
46 @signaldesc
47 Emitted before notification of multiple emails is handed to the UI to display.
48 @param subjects Subjects of emails being notified of.
49 @param froms Who the emails are from.
50 @param tos Who the emails are to.
51 @param urls The urls to view the emails.
52 @param count Number of emails being notified of.
53 @endsignaldef
54
21 */ 55 */
22 // vim: syntax=c tw=75 et 56 // vim: syntax=c tw=75 et