diff plugins/tcl/TCL-HOWTO @ 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/plugins/tcl/TCL-HOWTO	Fri May 21 14:26:31 2004 +0000
+++ b/plugins/tcl/TCL-HOWTO	Fri May 21 14:33:32 2004 +0000
@@ -296,7 +296,7 @@
 intended to be a list only of their arguments.  Signal callbacks will
 be made in their own namespace, and arguments to those signal
 callbacks will live in the namespace 'event' underneath that
-namespace.  To briefly illustrate, the signal received-im-msg is
+namespace.  To briefly illustrate, the signal receiving-im-msg is
 provided with three arguments; the account on which the IM was
 received, the screen name of the user sending the IM, and the text of
 the IM.  These arguments live in the variables event::account,
@@ -304,14 +304,14 @@
 which notifies the user of an incoming IM containing the word 'shizzle'
 might look like this:
 
-gaim::signal connect [gaim::conversation handle] received-im-msg {
+gaim::signal connect [gaim::conversation handle] receiving-im-msg {
 	if {[ string match "*shizzle*" $event::buffer ]} {
 		gaim::notify -info "tcl plugin" "Fo' shizzle" \
 			"$event::sender is down with the shizzle"
 	}
 }
 
-Note that for some signals (notably received-im-msg, sending-im-msg,
+Note that for some signals (notably receiving-im-msg, sending-im-msg,
 and their chat counterparts), changes to the event arguments will
 change the message itself from Gaim's vantage.  For those signals
 whose return value is meaningful, returning a value from the Tcl event