annotate doc/account-signals.dox @ 32319:06c38384f43d

Remove purple_util_fetch_url_request_len() and change the few places that used it to use purple_util_fetch_url_request_len_with_account()
author Mark Doliner <mark@kingant.net>
date Sun, 21 Aug 2011 01:52:25 +0000
parents 28e27a37e4b4
children 02a2e8183b1d
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
26845
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
4 @signal account-created
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
5 @signal account-destroying
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
6 @signal account-added
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
7 @signal account-connecting
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
8 @signal account-removed
12127
944c97d11bb1 [gaim-migrate @ 14427]
Richard Laager <rlaager@wiktel.com>
parents: 12070
diff changeset
9 @signal account-disabled
944c97d11bb1 [gaim-migrate @ 14427]
Richard Laager <rlaager@wiktel.com>
parents: 12070
diff changeset
10 @signal account-enabled
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
11 @signal account-setting-info
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
12 @signal account-set-info
11628
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
13 @signal account-status-changed
26776
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
14 @signal account-actions-changed
21064
1aaa6e9881b9 Add the account-alias-changed signal to the summary at the top.
Etan Reisner <pidgin@unreliablesource.net>
parents: 20807
diff changeset
15 @signal account-alias-changed
21221
e98c08afb706 Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 21220
diff changeset
16 @signal account-authorization-requested
31820
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
17 @signal account-authorization-requested-with-message
21221
e98c08afb706 Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 21220
diff changeset
18 @signal account-authorization-denied
e98c08afb706 Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 21220
diff changeset
19 @signal account-authorization-granted
21366
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
20 @signal account-error-changed
30119
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
21 @signal account-signed-on
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
22 @signal account-signed-off
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
23 @signal account-connection-error
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 @endsignals
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
25
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16183
diff changeset
26 @see account.h
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16183
diff changeset
27
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28 <hr>
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29
26845
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
30 @signaldef account-created
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
31 @signalproto
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
32 void (*account_created)(PurpleAccount *account);
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
33 @endsignalproto
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
34 @signaldesc
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
35 Emitted when an account is created by calling purple_account_new.
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
36 @param account The account.
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
37 @since 2.6.0
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
38 @endsignaldef
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
39
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
40 @signaldef account-destroying
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
41 @signalproto
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
42 void (*account_destroying)(PurpleAccount *account);
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
43 @endsignalproto
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
44 @signaldesc
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
45 Emitted when an account is about to be destroyed.
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
46 @param account The account.
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
47 @since 2.6.0
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
48 @endsignaldef
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
49
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
50 @signaldef account-added
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
51 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
52 void (*account_added)(PurpleAccount *account);
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
53 @endsignalproto
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
54 @signaldesc
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
55 Emitted when an account is added.
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
56 @param account The account that was added.
26845
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
57 @see purple_accounts_add
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
58 @endsignaldef
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
59
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
60 @signaldef account-connecting
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
61 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
62 void (*account_connecting)(PurpleAccount *account);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
63 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
64 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
65 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
66 @param account The account in the process of connecting.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
67 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
68
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
69 @signaldef account-removed
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
70 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
71 void (*account_removed)(PurpleAccount *account);
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
72 @endsignalproto
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
73 @signaldesc
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
74 Emitted when an account is removed.
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
75 @param account The account that was removed.
26845
76a1598ecf1c Add account-(created|destroying) signals.
Paul Aurich <paul@darkrain42.org>
parents: 26776
diff changeset
76 @see purple_accounts_remove
12053
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
77 @endsignaldef
1ec93dd2f359 [gaim-migrate @ 14348]
Nathan Walp <nwalp@pidgin.im>
parents: 11685
diff changeset
78
12070
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
79 @signaldef account-disabled
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
80 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
81 void (*account_disabled)(PurpleAccount *account);
12070
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
82 @endsignalproto
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
83 @signaldesc
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
84 Emitted when an account is disabled.
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
85 @param account The account that was disabled.
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
86 @endsignaldef
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
87
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
88 @signaldef account-enabled
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
89 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
90 void (*account_enabled)(PurpleAccount *account);
12070
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
91 @endsignalproto
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
92 @signaldesc
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
93 Emitted when an account is enabled.
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
94 @param account The account that was enabled.
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
95 @endsignaldef
e4666705944b [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
96
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
97 @signaldef account-setting-info
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
98 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
99 void (*account_setting_info)(PurpleAccount *account, const char *new_info);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
100 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
101 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
102 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
103 profile, to the server.
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
104 @param account The account that the info will be set on.
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
105 @param new_info The new information to set.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
106 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
107
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
108 @signaldef account-set-info
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
109 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
110 void (*account_set_info)(PurpleAccount *account, const char *new_info);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
111 @endsignalproto
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
112 @signaldesc
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
113 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
114 @param account The account that the info was set on.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
115 @param new_info The new information set.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
116 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
117
11628
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
118 @signaldef account-status-changed
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
119 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
120 void (*account_status_changed)(PurpleAccount *account, PurpleStatus *old, PurpleStatus *new);
11628
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
121 @endsignalproto
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
122 @signaldesc
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
123 Emitted when the status of an account changes (after the change).
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
124 @param account The account that changed status.
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
125 @param old The status before change.
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
126 @param new The status after change.
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
127 @endsignaldef
e1e47878d0ed [gaim-migrate @ 13903]
Tim Ringenbach <marv@pidgin.im>
parents: 9447
diff changeset
128
26776
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
129 @signaldef account-actions-changed
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
130 @signalproto
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
131 void (*account_actions_changed)(PurpleAccount *account);
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
132 @endsignalproto
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
133 @signaldesc
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
134 Emitted when the account actions are changed after initial connection.
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
135 @param account The account whose actions changed.
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
136 @endsignaldef
83e6e710cbf3 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <paul@darkrain42.org>
parents: 26327
diff changeset
137
13281
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
138 @signaldef account-alias-changed
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
139 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 13281
diff changeset
140 void (*account_alias_changed)(PurpleAccount *account, const char *old);
13281
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
141 @endsignalproto
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
142 @signaldesc
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
143 Emitted when the alias of an account changes (after the change).
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
144 @param account The account for which the alias was changed.
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
145 @param old The alias before change.
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
146 @endsignaldef
e629076386f1 [gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents: 12127
diff changeset
147
20178
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
148 @signaldef account-authorization-requested
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
149 @signalproto
26327
5b522d6e04ca Update the documentation for the account-authorization-requested signal, as
Richard Laager <rlaager@wiktel.com>
parents: 22300
diff changeset
150 int (*account_authorization_requested)(PurpleAccount *account, const char *user);
20178
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
151 @endsignalproto
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
152 @signaldesc
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
153 Emitted when a user requests authorization.
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
154 @param account The account.
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
155 @param user The name of the user requesting authorization.
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
156 @return Less than zero to deny the request without prompting, greater
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
157 than zero if the request should be granted. If zero is returned,
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
158 then the user will be prompted with the request.
21221
e98c08afb706 Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 21220
diff changeset
159 @since 2.3.0
20178
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
160 @endsignaldef
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
161
31820
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
162 @signaldef account-authorization-requested-with-message
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
163 @signalproto
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
164 int (*account_authorization_requested)(PurpleAccount *account, const char *user, const char *message);
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
165 @endsignalproto
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
166 @signaldesc
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
167 Emitted when a user requests authorization.
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
168 @param account The account.
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
169 @param user The name of the user requesting authorization.
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
170 @param message The authorization request message
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
171 @return PURPLE_ACCOUNT_RESPONSE_IGNORE to silently ignore the request,
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
172 PURPLE_ACCOUNT_RESPONSE_DENY to block the request (the sender might
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
173 get informed, PURPLE_ACCOUNT_RESPONSE_ACCEPT if the request should be
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
174 granted. If PURPLE_ACCOUNT_RESPONSE_PASS is returned, then the user
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
175 will be prompted with the request.
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
176 @since 2.8.0
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
177 @endsignaldef
28e27a37e4b4 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 30119
diff changeset
178
20178
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
179 @signaldef account-authorization-denied
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
180 @signalproto
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
181 void (*account_authorization_denied)(PurpleAccount *account, const char *user);
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
182 @endsignalproto
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
183 @signaldesc
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
184 Emitted when the authorization request for a buddy is denied.
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
185 @param account The account.
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
186 @param user The name of the user requesting authorization.
21221
e98c08afb706 Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 21220
diff changeset
187 @since 2.3.0
20178
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
188 @endsignaldef
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
189
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
190 @signaldef account-authorization-granted
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
191 @signalproto
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
192 void (*account_authorization_granted)(PurpleAccount *account, const char *user);
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
193 @endsignalproto
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
194 @signaldesc
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
195 Emitted when the authorization request for a buddy is granted.
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
196 @param account The account.
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
197 @param user The name of the user requesting authorization.
21221
e98c08afb706 Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 21220
diff changeset
198 @since 2.3.0
20178
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
199 @endsignaldef
8e3ef71c4362 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 16183
diff changeset
200
21366
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
201 @signaldef account-error-changed
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
202 @signalproto
21377
872068d10eab Mark pointed out that PurpleConnectionErrorPair is not a very good name for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 21374
diff changeset
203 void (*account_error_changed)(PurpleAccount *account, const PurpleConnectionErrorInfo *old_error, const PurpleConnectionErrorInfo *current_error);
21366
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
204 @endsignalproto
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
205 @signaldesc
22300
cccdcc7e5642 I think it's reasonable to just say "don't do this".
Will Thompson <will.thompson@collabora.co.uk>
parents: 21597
diff changeset
206 Emitted when @a account's error changes. You should not call
cccdcc7e5642 I think it's reasonable to just say "don't do this".
Will Thompson <will.thompson@collabora.co.uk>
parents: 21597
diff changeset
207 purple_account_clear_current_error() while this signal is being emitted.
21373
cbf197042bad Add the old error to the account-error-changed signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 21366
diff changeset
208 @param account The account whose error has changed.
cbf197042bad Add the old error to the account-error-changed signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 21366
diff changeset
209 @param old_error The account's previous error, or @c NULL if it had no
21379
30a532b14003 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <will.thompson@collabora.co.uk>
parents: 21377
diff changeset
210 error. After this signal is emitted, @a old_error is
30a532b14003 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <will.thompson@collabora.co.uk>
parents: 21377
diff changeset
211 not guaranteed to be a valid pointer.
21373
cbf197042bad Add the old error to the account-error-changed signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 21366
diff changeset
212 @param new_error The account's new error, or @c NULL if it has no error.
21379
30a532b14003 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <will.thompson@collabora.co.uk>
parents: 21377
diff changeset
213 If not @c NULL, @a new_error will remain a valid until
30a532b14003 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <will.thompson@collabora.co.uk>
parents: 21377
diff changeset
214 pointer just after the next time this signal is emitted
30a532b14003 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <will.thompson@collabora.co.uk>
parents: 21377
diff changeset
215 for this @a account.
21366
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
216 @see purple_account_get_current_error()
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
217 @since 2.3.0
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
218 @endsignaldef
8858a42ca237 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents: 21221
diff changeset
219
30119
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
220 @signaldef account-signed-on
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
221 @signalproto
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
222 void (*signed_on)(PurpleAccount *account);
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
223 @endsignalproto
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
224 @signaldesc
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
225 Emitted when an account has signed on.
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
226 @param account The account that has signed on.
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
227 @since 2.7.0
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
228 @endsignaldef
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
229
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
230 @signaldef account-signed-off
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
231 @signalproto
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
232 void (*signed_off)(PurpleAccount *account);
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
233 @endsignalproto
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
234 @signaldesc
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
235 Emitted when an account has signed off.
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
236 @param account The account that has signed off.
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
237 @since 2.7.0
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
238 @endsignaldef
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
239
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
240 @signaldef account-connection-error
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
241 @signalproto
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
242 void (*connection_error)(PurpleAccount *gc, PurpleConnectionError err, const gchar *desc)
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
243 @endsignalproto
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
244 @signaldesc
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
245 Emitted when a connection error occurs, before @ref signed-off.
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
246 @param account The account on which the error has occurred
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
247 @param err The error that occurred
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
248 @param desc A description of the error, giving more information.
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
249 @since 2.7.0
0417d6bc47cd Document those signals. Refs #11130.
Paul Aurich <paul@darkrain42.org>
parents: 26845
diff changeset
250 @endsignaldef
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
251 */
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16183
diff changeset
252 // vim: syntax=c.doxygen tw=75 et