comparison doc/account-signals.dox @ 30119:0417d6bc47cd

Document those signals. Refs #11130. I just noticed account-error-changed, which possibly overlaps some with account-connection-error, but this version provides the error code and string without requiring another D-Bus roundtrip.
author Paul Aurich <paul@darkrain42.org>
date Mon, 12 Apr 2010 04:01:07 +0000
parents 76a1598ecf1c
children 28e27a37e4b4
comparison
equal deleted inserted replaced
30118:4d0ccbc905aa 30119:0417d6bc47cd
15 @signal account-alias-changed 15 @signal account-alias-changed
16 @signal account-authorization-requested 16 @signal account-authorization-requested
17 @signal account-authorization-denied 17 @signal account-authorization-denied
18 @signal account-authorization-granted 18 @signal account-authorization-granted
19 @signal account-error-changed 19 @signal account-error-changed
20 @signal account-signed-on
21 @signal account-signed-off
22 @signal account-connection-error
20 @endsignals 23 @endsignals
21 24
22 @see account.h 25 @see account.h
23 26
24 <hr> 27 <hr>
194 for this @a account. 197 for this @a account.
195 @see purple_account_get_current_error() 198 @see purple_account_get_current_error()
196 @since 2.3.0 199 @since 2.3.0
197 @endsignaldef 200 @endsignaldef
198 201
202 @signaldef account-signed-on
203 @signalproto
204 void (*signed_on)(PurpleAccount *account);
205 @endsignalproto
206 @signaldesc
207 Emitted when an account has signed on.
208 @param account The account that has signed on.
209 @since 2.7.0
210 @endsignaldef
211
212 @signaldef account-signed-off
213 @signalproto
214 void (*signed_off)(PurpleAccount *account);
215 @endsignalproto
216 @signaldesc
217 Emitted when an account has signed off.
218 @param account The account that has signed off.
219 @since 2.7.0
220 @endsignaldef
221
222 @signaldef account-connection-error
223 @signalproto
224 void (*connection_error)(PurpleAccount *gc, PurpleConnectionError err, const gchar *desc)
225 @endsignalproto
226 @signaldesc
227 Emitted when a connection error occurs, before @ref signed-off.
228 @param account The account on which the error has occurred
229 @param err The error that occurred
230 @param desc A description of the error, giving more information.
231 @since 2.7.0
232 @endsignaldef
199 */ 233 */
200 // vim: syntax=c.doxygen tw=75 et 234 // vim: syntax=c.doxygen tw=75 et