Add an autojoin connection signal

UIs should use this so plugins can delay autojoining by blocking this
signal and re-emitting it later.  For example, IRC Helper now delays
autojoins until after it has identified with NickServ/AuthServ/etc.

1 files changed, 16 insertions, 0 deletions

diff --git a/doc/connection-signals.dox b/doc/connection-signals.dox
index bb6a8118ef..84849876e8 100644
--- a/doc/connection-signals.dox
+++ b/doc/connection-signals.dox
@@ -3,6 +3,7 @@
  @signals
   @signal signing-on
   @signal signed-on
+  @signal autojoin
   @signal signing-off
   @signal signed-off
   @signal connection-error
@@ -30,6 +31,21 @@ void (*signed_on)(PurpleConnection *gc);
   @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);