diff doc/gtkconv-signals.dox @ 13233:f09c6e8df82c

[gaim-migrate @ 15598] SF Patch #1417225 from Sadrul This reworks the conversation signals. committer: Tailor Script <[e-mail]>

--- a/doc/gtkconv-signals.dox	Sat Feb 11 19:07:49 2006 +0000
+++ b/doc/gtkconv-signals.dox	Sat Feb 11 19:16:38 2006 +0000
@@ -37,8 +37,9 @@
 
  @signaldef displaying-im-msg
   @signalproto
-gboolean (*displaying_im_msg)(GaimAccount *account, GaimConversation *conv,
-                              char **message, GaimMessageFlags flags);
+gboolean (*displaying_im_msg)(GaimAccount *account, const char *who,
+                              char **message, GaimConversation *conv,
+                              GaimMessageFlags flags);
   @endsignalproto
   @signaldesc
    Emitted just before a message is displayed in an IM conversation.
@@ -47,30 +48,34 @@
    a message by returning @c TRUE.
   @note
    Make sure to free @a *message before you replace it!
-  @param account The account the message is being displayed on.
-  @param conv    The conversation the message is being displayed on.
-  @param message A pointer to the message that will be displayed.
-  @param flags   The message flags.
+  @param account The account.
+  @param who     The name of the user.
+  @param message A pointer to the message.
+  @param conv    The conversation.
+  @param flags   Flags for this message.
   @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
  @endsignaldef
 
  @signaldef displayed-im-msg
   @signalproto
-void (*displayed_im_msg)(GaimAccount *account, GaimConversation *conv,
-                         const char *message, GaimMessageFlags flags);
+void (*displayed_im_msg)(GaimAccount *account, const char *who,
+                         char *message, GaimConversation *conv,
+                         GaimMessageFlags flags);
   @endsignalproto
   @signaldesc
    Emitted after a message is displayed in an IM conversation.
-  @param account The account the message was displayed on.
-  @param conv    The conversation the message was displayed on.
-  @param message The message that was displayed.
-  @param flags   The message flags.
+  @param account The account.
+  @param who     The name of the user.
+  @param message The message.
+  @param conv    The conversation.
+  @param flags   Flags for this message.
  @endsignaldef
 
  @signaldef displaying-chat-msg
   @signalproto
-gboolean (*displaying_chat_msg)(GaimAccount *account, GaimConversation *conv,
-                                char **message, GaimMessageFlags flags);
+gboolean (*displaying_chat_msg)(GaimAccount *account, const char *who,
+                                char **message, GaimConversation *conv,
+                                GaimMessageFlags flags);
   @endsignalproto
   @signaldesc
    Emitted just before a message is displayed in a chat.
@@ -79,24 +84,27 @@
    a message by returning @c TRUE.
   @note
    Make sure to free @a *message before you replace it!
-  @param account The account the message is being displayed on.
-  @param conv    The conversation the message is being displayed on.
-  @param message A pointer to the message that will be displayed.
-  @param flags   The message flags.
+  @param account The account the message is being displayed and sent on.
+  @param who     The name of the user.
+  @param message A pointer to the message that will be displayed and sent.
+  @param conv    The conversation the message is being displayed and sent on.
+  @param flags   Flags for this message.
   @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
  @endsignaldef
 
  @signaldef displayed-chat-msg
   @signalproto
-void (*displayed_chat_msg)(GaimAccount *account, GaimConversation *conv,
-                           const char *message, GaimMessageFlags flags);
+void (*displayed_chat_msg)(GaimAccount *account, const char *who,
+                           char *message, GaimConversation *conv,
+                           GaimMessageFlags flags);
   @endsignalproto
   @signaldesc
    Emitted after a message is displayed in a chat conversation.
-  @param account The account the message was displayed on.
-  @param conv    The conversation the message was displayed on.
-  @param message The message that was displayed.
-  @param flags   The message flags.
+  @param account The account the message is being displayed and sent on.
+  @param who     The name of the user.
+  @param message A pointer to the message that will be displayed and sent.
+  @param conv    The conversation the message is being displayed and sent on.
+  @param flags   Flags for this message.
  @endsignaldef
 
  @signaldef conversation-switched