annotate doc/account-signals.dox @ 12441:d7dc4b33fd69

[gaim-migrate @ 14748] Fix an abuse of g_return_val_if_fail, gaim_status_get_attr_value is called on statuses that may not have the attribute set. committer: Tailor Script <tailor@pidgin.im>
author Stu Tomlinson <stu@nosnilmot.com>
date Fri, 09 Dec 2005 12:46:24 +0000
parents 944c97d11bb1
children e629076386f1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1 /** @page account-signals Account Signals
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
2
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
3 @signals
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
4 @signal account-added
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
5 @signal account-connecting
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
6 @signal account-removed
12127
944c97d11bb1 [gaim-migrate @ 14427]
Richard Laager <rlaager@wiktel.com>
parents: 12070
diff changeset
7 @signal account-disabled
944c97d11bb1 [gaim-migrate @ 14427]
Richard Laager <rlaager@wiktel.com>
parents: 12070
diff changeset
8 @signal account-enabled
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
9 @signal account-setting-info
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
10 @signal account-set-info
11628
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
11 @signal account-status-changed
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
12 @endsignals
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
13
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
14 <hr>
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
15
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
16 @signaldef account-added
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
17 @signalproto
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
18 void (*account_added)(GaimAccount *account);
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
19 @endsignalproto
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
20 @signaldesc
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
21 Emitted when an account is added.
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
22 @param account The account that was added.
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
23 @endsignaldef
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
24
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
25 @signaldef account-connecting
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
26 @signalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
27 void (*account_connecting)(GaimAccount *account);
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30 This is called when an account is in the process of connecting.
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
31 @param account The account in the process of connecting.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
32 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
33
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
34 @signaldef account-removed
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
35 @signalproto
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
36 void (*account_removed)(GaimAccount *account);
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
37 @endsignalproto
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
38 @signaldesc
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
39 Emitted when an account is removed.
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
40 @param account The account that was removed.
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
41 @endsignaldef
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
42
12070
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
43 @signaldef account-disabled
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
44 @signalproto
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
45 void (*account_disabled)(GaimAccount *account);
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
46 @endsignalproto
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
47 @signaldesc
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
48 Emitted when an account is disabled.
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
49 @param account The account that was disabled.
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
50 @endsignaldef
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
51
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
52 @signaldef account-enabled
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
53 @signalproto
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
54 void (*account_enabled)(GaimAccount *account);
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
55 @endsignalproto
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
56 @signaldesc
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
57 Emitted when an account is enabled.
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
58 @param account The account that was enabled.
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
59 @endsignaldef
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
60
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
61 @signaldef account-setting-info
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
62 @signalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
63 void (*account_setting_info)(GaimAccount *account, const char *new_info);
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
64 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
65 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
66 Emitted when a user is about to send his new user info, or
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
67 profile, to the server.
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
68 @param account The account that the info will be set on.
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
69 @param new_info The new information to set.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
70 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
71
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
72 @signaldef account-set-info
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
73 @signalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
74 void (*account_set_info)(GaimAccount *account, const char *new_info);
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
75 @endsignalproto
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
76 @signaldesc
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
77 Emitted when a user sent his new user info, or profile, to the server.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
78 @param account The account that the info was set on.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
79 @param new_info The new information set.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
80 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
81
11628
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
82 @signaldef account-status-changed
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
83 @signalproto
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
84 void (*account_status_changed)(GaimAccount *account, GaimStatus *old, GaimStatus *new);
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
85 @endsignalproto
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
86 @signaldesc
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
87 Emitted when the status of an account changes (after the change).
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
88 @param account The account that changed status.
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
89 @param old The status before change.
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
90 @param new The status after change.
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
91 @endsignaldef
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
92
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
93 */
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
94 // vim: syntax=c tw=75 et