Mercurial > pidgin
changeset 29708: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 | 4d0ccbc905aa |
| children | 87b166bd3760 |
| files | doc/account-signals.dox |
| diffstat | 1 files changed, 34 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/account-signals.dox Mon Apr 12 03:55:07 2010 +0000 +++ b/doc/account-signals.dox Mon Apr 12 04:01:07 2010 +0000 @@ -17,6 +17,9 @@ @signal account-authorization-denied @signal account-authorization-granted @signal account-error-changed + @signal account-signed-on + @signal account-signed-off + @signal account-connection-error @endsignals @see account.h @@ -196,5 +199,36 @@ @since 2.3.0 @endsignaldef + @signaldef account-signed-on + @signalproto +void (*signed_on)(PurpleAccount *account); + @endsignalproto + @signaldesc + Emitted when an account has signed on. + @param account The account that has signed on. + @since 2.7.0 + @endsignaldef + + @signaldef account-signed-off + @signalproto +void (*signed_off)(PurpleAccount *account); + @endsignalproto + @signaldesc + Emitted when an account has signed off. + @param account The account that has signed off. + @since 2.7.0 + @endsignaldef + + @signaldef account-connection-error + @signalproto +void (*connection_error)(PurpleAccount *gc, PurpleConnectionError err, const gchar *desc) + @endsignalproto + @signaldesc + Emitted when a connection error occurs, before @ref signed-off. + @param account The account on which the error has occurred + @param err The error that occurred + @param desc A description of the error, giving more information. + @since 2.7.0 + @endsignaldef */ // vim: syntax=c.doxygen tw=75 et