diff doc/conversation-signals.dox @ 8999:8f838ae3e710

[gaim-migrate @ 9774] " This patch renames the existing received-*-msg signals to receiving-*msg to fit the naming of other signals where a pointer to the message is passed (writing, sending, displaying) It adds new received-*-msg signals which are emitted after the receiving signals, in line with the other conversation signals (wrote, sent, displayed) This is necessary to allow plugins which depend on the final received message to work alongside plugins which may modify the message. One known example of this is festival-gaim alongside gaim-encryption - festival-gaim would try to "speak" the encrypted text: http://sf.net/tracker/?func=detail&aid=943216&group_id=89763&atid=591320 I've tested this with gaim-encryption and festival-gaim (locally modified so gaim-encryption uses the receiving signal and festival uses the received signal) All in-tree users of received-*-msg are updated to use receiving-*-msg if they do modify the message, the conversation-signals documentation is updated, the signals-test.c & signal-test.tcl plugins are also updated." --Stu Tomlinson committer: Tailor Script <[e-mail]>

--- a/doc/conversation-signals.dox	Fri May 21 14:26:31 2004 +0000
+++ b/doc/conversation-signals.dox	Fri May 21 14:33:32 2004 +0000
@@ -7,6 +7,7 @@
   @signal displayed-im-msg
   @signal sending-im-msg
   @signal sent-im-msg
+  @signal receiving-im-msg
   @signal received-im-msg
   @signal writing-chat-msg
   @signal wrote-chat-msg
@@ -14,6 +15,7 @@
   @signal displayed-chat-msg
   @signal sending-chat-msg
   @signal sent-chat-msg
+  @signal receiving-chat-msg
   @signal received-chat-msg
   @signal conversation-switching
   @signal conversation-switched
@@ -118,9 +120,9 @@
   @param message  The message that was sent.
  @endsignaldef
 
- @signaldef received-im-msg
+ @signaldef receiving-im-msg
   @signalproto
-gboolean (*received_im_msg)(GaimAccount *account, char **sender,
+gboolean (*receiving_im_msg)(GaimAccount *account, char **sender,
                             char **message, int *flags);
   @endsignalproto
   @signaldesc
@@ -137,6 +139,19 @@
   @param flags   The message flags.
  @endsignaldef
 
+ @signaldef received-im-msg
+  @signalproto
+void (*received_im_msg)(GaimAccount *account, char *sender,
+                            char *message, int flags);
+  @endsignalproto
+  @signaldesc
+   Emitted after an IM is received.
+  @param account The account the message was received on.
+  @param sender  The username of the sender.
+  @param message The message that was sent.
+  @param flags   The message flags.
+ @endsignaldef
+
  @signaldef writing-chat-msg
   @signalproto
 gboolean (*writing_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message);
@@ -222,9 +237,9 @@
   @param id      The ID of the chat.
  @endsignaldef
 
- @signaldef received-chat-msg
+ @signaldef receiving-chat-msg
   @signalproto
-gboolean (*received_chat_msg)(GaimAccount *account, char **sender,
+gboolean (*receiving_chat_msg)(GaimAccount *account, char **sender,
                               char **message, GaimConversation *conv);
   @endsignalproto
   @signaldesc
@@ -241,6 +256,19 @@
   @param conv    The chat conversation.
  @endsignaldef
 
+ @signaldef received-chat-msg
+  @signalproto
+void (*received_chat_msg)(GaimAccount *account, char *sender,
+                              char *message, GaimConversation *conv);
+  @endsignalproto
+  @signaldesc
+   Emitted after a chat message is received.
+  @param account The account the message was received on.
+  @param sender  The username of the sender.
+  @param message The message that was sent.
+  @param conv    The chat conversation.
+ @endsignaldef
+
  @signaldef conversation-switching
   @signalproto
 void (*conversation_switching)(GaimConversation *old_conv,