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