comparison doc/account-signals.dox @ 32819:2c6510167895 default tip

propagate from branch 'im.pidgin.pidgin.2.x.y' (head 3315c5dfbd0ad16511bdcf865e5b07c02d07df24) to branch 'im.pidgin.pidgin' (head cbd1eda6bcbf0565ae7766396bb8f6f419cb6a9a)
author Elliott Sales de Andrade <qulogic@pidgin.im>
date Sat, 02 Jun 2012 02:30:49 +0000
parents 02a2e8183b1d
children
comparison
equal deleted inserted replaced
32818:01ff09d4a463 32819:2c6510167895
32 void (*account_created)(PurpleAccount *account); 32 void (*account_created)(PurpleAccount *account);
33 @endsignalproto 33 @endsignalproto
34 @signaldesc 34 @signaldesc
35 Emitted when an account is created by calling purple_account_new. 35 Emitted when an account is created by calling purple_account_new.
36 @param account The account. 36 @param account The account.
37 @since 2.6.0
38 @endsignaldef 37 @endsignaldef
39 38
40 @signaldef account-destroying 39 @signaldef account-destroying
41 @signalproto 40 @signalproto
42 void (*account_destroying)(PurpleAccount *account); 41 void (*account_destroying)(PurpleAccount *account);
43 @endsignalproto 42 @endsignalproto
44 @signaldesc 43 @signaldesc
45 Emitted when an account is about to be destroyed. 44 Emitted when an account is about to be destroyed.
46 @param account The account. 45 @param account The account.
47 @since 2.6.0
48 @endsignaldef 46 @endsignaldef
49 47
50 @signaldef account-added 48 @signaldef account-added
51 @signalproto 49 @signalproto
52 void (*account_added)(PurpleAccount *account); 50 void (*account_added)(PurpleAccount *account);
154 @param account The account. 152 @param account The account.
155 @param user The name of the user requesting authorization. 153 @param user The name of the user requesting authorization.
156 @return Less than zero to deny the request without prompting, greater 154 @return Less than zero to deny the request without prompting, greater
157 than zero if the request should be granted. If zero is returned, 155 than zero if the request should be granted. If zero is returned,
158 then the user will be prompted with the request. 156 then the user will be prompted with the request.
159 @since 2.3.0
160 @endsignaldef 157 @endsignaldef
161 158
162 @signaldef account-authorization-requested-with-message 159 @signaldef account-authorization-requested-with-message
163 @signalproto 160 @signalproto
164 int (*account_authorization_requested)(PurpleAccount *account, const char *user, const char *message); 161 int (*account_authorization_requested)(PurpleAccount *account, const char *user, const char *message);
171 @return PURPLE_ACCOUNT_RESPONSE_IGNORE to silently ignore the request, 168 @return PURPLE_ACCOUNT_RESPONSE_IGNORE to silently ignore the request,
172 PURPLE_ACCOUNT_RESPONSE_DENY to block the request (the sender might 169 PURPLE_ACCOUNT_RESPONSE_DENY to block the request (the sender might
173 get informed, PURPLE_ACCOUNT_RESPONSE_ACCEPT if the request should be 170 get informed, PURPLE_ACCOUNT_RESPONSE_ACCEPT if the request should be
174 granted. If PURPLE_ACCOUNT_RESPONSE_PASS is returned, then the user 171 granted. If PURPLE_ACCOUNT_RESPONSE_PASS is returned, then the user
175 will be prompted with the request. 172 will be prompted with the request.
176 @since 2.8.0
177 @endsignaldef 173 @endsignaldef
178 174
179 @signaldef account-authorization-denied 175 @signaldef account-authorization-denied
180 @signalproto 176 @signalproto
181 void (*account_authorization_denied)(PurpleAccount *account, const char *user); 177 void (*account_authorization_denied)(PurpleAccount *account, const char *user);
182 @endsignalproto 178 @endsignalproto
183 @signaldesc 179 @signaldesc
184 Emitted when the authorization request for a buddy is denied. 180 Emitted when the authorization request for a buddy is denied.
185 @param account The account. 181 @param account The account.
186 @param user The name of the user requesting authorization. 182 @param user The name of the user requesting authorization.
187 @since 2.3.0
188 @endsignaldef 183 @endsignaldef
189 184
190 @signaldef account-authorization-granted 185 @signaldef account-authorization-granted
191 @signalproto 186 @signalproto
192 void (*account_authorization_granted)(PurpleAccount *account, const char *user); 187 void (*account_authorization_granted)(PurpleAccount *account, const char *user);
193 @endsignalproto 188 @endsignalproto
194 @signaldesc 189 @signaldesc
195 Emitted when the authorization request for a buddy is granted. 190 Emitted when the authorization request for a buddy is granted.
196 @param account The account. 191 @param account The account.
197 @param user The name of the user requesting authorization. 192 @param user The name of the user requesting authorization.
198 @since 2.3.0
199 @endsignaldef 193 @endsignaldef
200 194
201 @signaldef account-error-changed 195 @signaldef account-error-changed
202 @signalproto 196 @signalproto
203 void (*account_error_changed)(PurpleAccount *account, const PurpleConnectionErrorInfo *old_error, const PurpleConnectionErrorInfo *current_error); 197 void (*account_error_changed)(PurpleAccount *account, const PurpleConnectionErrorInfo *old_error, const PurpleConnectionErrorInfo *current_error);
212 @param new_error The account's new error, or @c NULL if it has no error. 206 @param new_error The account's new error, or @c NULL if it has no error.
213 If not @c NULL, @a new_error will remain a valid until 207 If not @c NULL, @a new_error will remain a valid until
214 pointer just after the next time this signal is emitted 208 pointer just after the next time this signal is emitted
215 for this @a account. 209 for this @a account.
216 @see purple_account_get_current_error() 210 @see purple_account_get_current_error()
217 @since 2.3.0
218 @endsignaldef 211 @endsignaldef
219 212
220 @signaldef account-signed-on 213 @signaldef account-signed-on
221 @signalproto 214 @signalproto
222 void (*signed_on)(PurpleAccount *account); 215 void (*signed_on)(PurpleAccount *account);
223 @endsignalproto 216 @endsignalproto
224 @signaldesc 217 @signaldesc
225 Emitted when an account has signed on. 218 Emitted when an account has signed on.
226 @param account The account that has signed on. 219 @param account The account that has signed on.
227 @since 2.7.0
228 @endsignaldef 220 @endsignaldef
229 221
230 @signaldef account-signed-off 222 @signaldef account-signed-off
231 @signalproto 223 @signalproto
232 void (*signed_off)(PurpleAccount *account); 224 void (*signed_off)(PurpleAccount *account);
233 @endsignalproto 225 @endsignalproto
234 @signaldesc 226 @signaldesc
235 Emitted when an account has signed off. 227 Emitted when an account has signed off.
236 @param account The account that has signed off. 228 @param account The account that has signed off.
237 @since 2.7.0
238 @endsignaldef 229 @endsignaldef
239 230
240 @signaldef account-connection-error 231 @signaldef account-connection-error
241 @signalproto 232 @signalproto
242 void (*connection_error)(PurpleAccount *gc, PurpleConnectionError err, const gchar *desc) 233 void (*connection_error)(PurpleAccount *gc, PurpleConnectionError err, const gchar *desc)
244 @signaldesc 235 @signaldesc
245 Emitted when a connection error occurs, before @ref signed-off. 236 Emitted when a connection error occurs, before @ref signed-off.
246 @param account The account on which the error has occurred 237 @param account The account on which the error has occurred
247 @param err The error that occurred 238 @param err The error that occurred
248 @param desc A description of the error, giving more information. 239 @param desc A description of the error, giving more information.
249 @since 2.7.0
250 @endsignaldef 240 @endsignaldef
251 */ 241 */
252 // vim: syntax=c.doxygen tw=75 et 242 // vim: syntax=c.doxygen tw=75 et