comparison: doc/reference/libpurple/connection-signals.dox
doc/reference/libpurple/connection-signals.dox
- branch
- soc.2013.gobjectification.plugins
- changeset 36900
- 423fbe5e5289
- parent 32438
- dc8991868906
equal
deleted
inserted
replaced
| 36899:b2591070c07b | 36900:423fbe5e5289 |
|---|---|
| 1 /** @page connection-signals Connection Signals | |
| 2 | |
| 3 @signals | |
| 4 @signal signing-on | |
| 5 @signal signed-on | |
| 6 @signal autojoin | |
| 7 @signal signing-off | |
| 8 @signal signed-off | |
| 9 @signal connection-error | |
| 10 @endsignals | |
| 11 | |
| 12 @see connection.h | |
| 13 | |
| 14 <hr> | |
| 15 | |
| 16 @signaldef signing-on | |
| 17 @signalproto | |
| 18 void (*signing_on)(PurpleConnection *gc); | |
| 19 @endsignalproto | |
| 20 @signaldesc | |
| 21 Emitted when a connection is about to sign on. | |
| 22 @param gc The connection that is about to sign on. | |
| 23 @endsignaldef | |
| 24 | |
| 25 @signaldef signed-on | |
| 26 @signalproto | |
| 27 void (*signed_on)(PurpleConnection *gc); | |
| 28 @endsignalproto | |
| 29 @signaldesc | |
| 30 Emitted when a connection has signed on. | |
| 31 @param gc The connection that has signed on. | |
| 32 @endsignaldef | |
| 33 | |
| 34 @signaldef autojoin | |
| 35 @signalproto | |
| 36 gboolean (*autojoin)(PurpleConnection *gc); | |
| 37 @endsignalproto | |
| 38 @signaldesc | |
| 39 Emitted when a connection has signed on, after the signed-on signal, to | |
| 40 signal UIs to autojoin chats if they wish. UIs should connect to this | |
| 41 with @c PURPLE_SIGNAL_PRIORITY_HIGHEST to allow plugins to block this | |
| 42 signal before the UI sees it and then re-emit it later. | |
| 43 @param gc The connection that has signed on. | |
| 44 @return @c TRUE if the signal was handled or @c FALSE otherwise. In | |
| 45 practice, the return value is irrelevant, as it really only | |
| 46 exists so plugins can block the UI's autojoin. | |
| 47 @endsignaldef | |
| 48 | |
| 49 @signaldef signing-off | |
| 50 @signalproto | |
| 51 void (*signing_off)(PurpleConnection *gc); | |
| 52 @endsignalproto | |
| 53 @signaldesc | |
| 54 Emitted when a connection is about to sign off. | |
| 55 @param gc The connection that is about to sign off. | |
| 56 @endsignaldef | |
| 57 | |
| 58 @signaldef signed-off | |
| 59 @signalproto | |
| 60 void (*signed_off)(PurpleConnection *gc); | |
| 61 @endsignalproto | |
| 62 @signaldesc | |
| 63 Emitted when a connection has signed off. | |
| 64 @param gc The connection that has signed off. | |
| 65 @endsignaldef | |
| 66 | |
| 67 @signaldef connection-error | |
| 68 @signalproto | |
| 69 void (*connection_error)(PurpleConnection *gc, PurpleConnectionError err, const gchar *desc) | |
| 70 @endsignalproto | |
| 71 @signaldesc | |
| 72 Emitted when a connection error occurs, before @ref signed-off. | |
| 73 @param gc The connection on which the error has occurred | |
| 74 @param err The error that occurred | |
| 75 @param desc A description of the error, giving more information. | |
| 76 @endsignaldef | |
| 77 | |
| 78 */ | |
| 79 // vim: syntax=c.doxygen tw=75 et |
