Mercurial > pidgin
view doc/connection-signals.dox @ 32253:9173ec5a45cf
merge of '1b285d0b375fbd5e778db6bb852a7b089feb16a3'
and 'd1328041ee003fdee29a0cf6ae44b44727a49bb8'
author | Kevin Stange <kevin@simguy.net> |
---|---|
date | Sun, 02 Oct 2011 00:06:40 +0000 |
parents | 02a2e8183b1d |
children |
line wrap: on
line source
/** @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. @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