Mercurial > pidgin
diff doc/connection-signals.dox @ 29753:378cceb9131d
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.
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Sun, 18 Apr 2010 22:39:01 +0000 |
parents | 73c8e1964eef |
children | 50729e095c3c |
line wrap: on
line diff
--- a/doc/connection-signals.dox Sat Apr 17 22:22:52 2010 +0000 +++ b/doc/connection-signals.dox Sun Apr 18 22:39:01 2010 +0000 @@ -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 @@ @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);