Mercurial > pidgin3 / file diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/reference/libpurple/connection-signals.dox	Sun Oct 13 15:41:22 2013 +0530
@@ -0,0 +1,79 @@
+/** @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