Mercurial > pidgin.yaz
comparison doc/account-signals.dox @ 6605:943b03bcecf5
[gaim-migrate @ 7129]
Added some signal documentation. The conversation signal docs are taking
forever. Who wants to help? :)
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Sun, 24 Aug 2003 06:32:28 +0000 |
parents | |
children | 34eaa941ecd6 |
comparison
equal
deleted
inserted
replaced
6604:693262ed19dc | 6605:943b03bcecf5 |
---|---|
1 /** @page account-signals Account Signals | |
2 | |
3 @signals | |
4 @signal account-away | |
5 @signal account-connecting | |
6 @signal account-setting-info | |
7 @signal account-set-info | |
8 @endsignals | |
9 | |
10 <hr> | |
11 | |
12 @signaldef account-away | |
13 @signalproto | |
14 void (*account_away)(GaimAccount *account, const char *state, const char *message); | |
15 @endsignalproto | |
16 @param account The account that went away. | |
17 @param state The away state. | |
18 @param message The away message. | |
19 @signaldesc | |
20 Emitted when an account goes away. | |
21 @endsignaldef | |
22 | |
23 @signaldef account-connecting | |
24 @signalproto | |
25 void (*account_connecting)(GaimAccount *account); | |
26 @endsignalproto | |
27 @param account The account in the process of connecting. | |
28 @signaldesc | |
29 This is called when an account is in the process of connecting. | |
30 @endsignaldef | |
31 | |
32 @signaldef account-setting-info | |
33 @signalproto | |
34 void (*account_setting_info)(GaimAccount *account, const char *new_info); | |
35 @endsignalproto | |
36 @param account The account that the info will be set on. | |
37 @param new_info The new information to set. | |
38 @signaldesc | |
39 Emitted when a user is about to send his new user info, or | |
40 profile, to the server. | |
41 @endsignaldef | |
42 | |
43 @signaldef account-set-info | |
44 @signalproto | |
45 void (*account_set_info)(GaimAccount *account, const char *new_info); | |
46 @endsignalproto | |
47 @param account The account that the info was set on. | |
48 @param new_info The new information set. | |
49 @signaldesc | |
50 Emitted when a user sent his new user info, or profile, to the server. | |
51 @endsignaldef | |
52 | |
53 @signaldef account-warned | |
54 @signalproto | |
55 void (*account_warned)(GaimAccount *account, const char *warner, int level); | |
56 @endsignalproto | |
57 @param account The account that was warned. | |
58 @param warner The screenname of the user that warned the account. | |
59 @param level The new warning level. | |
60 @signaldesc | |
61 Emitted when an account got warned. | |
62 @endsignaldef | |
63 | |
64 */ | |
65 // vim: syntax=c tw=75 et |