doc/connection-signals.dox

   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   @since 2.7.0
  48  @endsignaldef
  49
  50  @signaldef signing-off
  51   @signalproto
  52 void (*signing_off)(PurpleConnection *gc);
  53   @endsignalproto
  54   @signaldesc
  55    Emitted when a connection is about to sign off.
  56   @param gc The connection that is about to sign off.
  57  @endsignaldef
  58
  59  @signaldef signed-off
  60   @signalproto
  61 void (*signed_off)(PurpleConnection *gc);
  62   @endsignalproto
  63   @signaldesc
  64    Emitted when a connection has signed off.
  65   @param gc The connection that has signed off.
  66  @endsignaldef
  67
  68  @signaldef connection-error
  69   @signalproto
  70 void (*connection_error)(PurpleConnection *gc, PurpleConnectionError err, const gchar *desc)
  71   @endsignalproto
  72   @signaldesc
  73    Emitted when a connection error occurs, before @ref signed-off.
  74    @param gc     The connection on which the error has occurred
  75    @param err    The error that occurred
  76    @param desc   A description of the error, giving more information.
  77  @endsignaldef
  78
  79  */
  80 // vim: syntax=c.doxygen tw=75 et