annotate doc/notify-signals.dox @ 30009:1b1fee952341

jabber: trailing_whitespace--;
author Paul Aurich <paul@darkrain42.org>
date Fri, 21 May 2010 05:28:59 +0000
parents d1744f75199f
children 02a2e8183b1d
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
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
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
7 @endsignals
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
8
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 18675
diff changeset
9 @see notify.h
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 18675
diff changeset
10
12129
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
11 @signaldef displaying-userinfo
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
12 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 15265
diff changeset
13 void (*displaying_userinfo)(PurpleAccount *account, const char *who, PurpleNotifyUserInfo *user_info);
12129
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
14 @endsignalproto
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
15 @signaldesc
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
16 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
17 @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
18 @note
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 15265
diff changeset
19 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
20 @param account The account on which the info was obtained.
25925
6e1967b0f90b Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents: 20875
diff changeset
21 @param who The name of the buddy 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
22 @param user_info The information to be displayed, as PurpleNotifyUserInfoEntry objects
12129
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
23 @endsignaldef
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
24
18675
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
25 @signaldef displaying-email-notification
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
26 @signalproto
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
27 void (*displaying_email_notification)(const char *subject,
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
28 const char *from,
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
29 const char *to,
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
30 const char *url);
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
31 @endsignalproto
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
32 @signaldesc
25636
1a5861622794 Clarify that the displaying-email-notification signal only fires for
Etan Reisner <pidgin@unreliablesource.net>
parents: 20875
diff changeset
33 Emitted before notification of a single email is handed to the UI to display.
18675
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
34 @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
35 @param from Who the email is from.
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
36 @param to Who the email is to.
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
37 @param url A url to view the email.
20875
4511d15a8f80 Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 20807
diff changeset
38 @since 2.1.0
18675
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
39 @endsignaldef
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
40
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
41 @signaldef displaying-emails-notification
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
42 @signalproto
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
43 void (*displaying_emails_notification)(const char **subjects,
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
44 const char **froms,
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
45 const char **tos,
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
46 const char **urls,
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
47 guint count);
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
48 @endsignalproto
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
49 @signaldesc
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
50 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
51 @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
52 @param froms Who the emails are from.
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
53 @param tos Who the emails are to.
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
54 @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
55 @param count Number of emails being notified of.
20875
4511d15a8f80 Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 20807
diff changeset
56 @since 2.1.0
18675
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
57 @endsignaldef
cb91bb07eeff Email notification signals from charkins. Fixes #1324
Sean Egan <seanegan@gmail.com>
parents: 18357
diff changeset
58
12129
216988c717da [gaim-migrate @ 14429]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
59 */
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 18675
diff changeset
60 // vim: syntax=c.doxygen tw=75 et