diff doc/conversation-signals.dox @ 9587:5e1c76f3d232

[gaim-migrate @ 10430] " These 2 patches (one or the other, they are mutually exclusive) fix a slight bug in the gaim_conv_chat_add_user (it was not emitting the user's flags in the chat joining/joined signals). The 1st patch (gaim-0.81cvs-chat-join-signal-fix.patch) just fixes that bug, and nothing else. The 2nd patch (gaim-0.81cvs-chat-join-signal-fix-and-change.patch) also changes the joining/leaving signals to boolean signals to allow a plugin to optionally prevent the display of users joining and leaving chats. This would allow us to respond to "How do I turn off the display of users joinging and leaving a chat?" with "Write a plugin", instead of "You can't"." --Stu Tomlinson - nosnilmot should we be updating the ChangeLog.API? committer: Tailor Script <[e-mail]>

--- a/doc/conversation-signals.dox	Sat Jul 24 15:22:19 2004 +0000
+++ b/doc/conversation-signals.dox	Sat Jul 24 15:26:09 2004 +0000
@@ -331,12 +331,13 @@
 
  @signaldef chat-buddy-joining
   @signalproto
-void (*chat_buddy_joining)(GaimConversation *conv, const char *name,
+gboolean (*chat_buddy_joining)(GaimConversation *conv, const char *name,
                            GaimConvChatBuddyFlags flags);
   @endsignalproto
   @signaldesc
    Emitted when a buddy is joining a chat, before the list of
    users in the chat updates to include the new user.
+  @return @c TRUE if the join should be hidden, or @c FALSE otherwise.
   @param conv The chat conversation.
   @param name The name of the user that is joining the conversation.
   @param flags The flags of the user that is joining the conversation.
@@ -370,12 +371,13 @@
 
  @signaldef chat-buddy-leaving
   @signalproto
-void (*chat_buddy_leaving)(GaimConversation *conv, const char *name,
+gboolean (*chat_buddy_leaving)(GaimConversation *conv, const char *name,
                            const char *reason);
   @endsignalproto
   @signaldesc
    Emitted when a user is leaving a chat, before the user list is updated.
    This may include an optional reason why the user is leaving.
+  @return @c TRUE if the leave should be hidden, or @c FALSE otherwise.
   @param conv   The chat conversation.
   @param name   The name of the user that is leaving the chat.
   @param reason The optional reason why the user is leaving.