[Gaim-commits] CVS: gaim/doc log-signals.dox,NONE,1.1 Makefile.am,1.27,1.28 gtkconv-signals.dox,1.4,1.5

[Richard L. <rl...@us...>]

Update of /cvsroot/gaim/gaim/doc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv21680/doc

Modified Files:
	Makefile.am gtkconv-signals.dox 
Added Files:
	log-signals.dox 
Log Message:
Conversation and Logging Message Timestamp Formatting...

The idea here is that we should honor the user's locale for message timestamps in the conversation window and in the logs.

I've added a signal and created a plugin that allows one to override this. The plugin is named "Message Timestamp Formats". Enabling that will by default change the timestamps back to the format we had before this commit. (That is to say, it forces the old format and ignores the locale.) The plugin also has options to show dates in the timestamps "Always", "In Chats", or "For Delayed Messages" (the default behavior).

This addresses all requests for 12 hour timestamps, allows people to continue with the 24 hour timestamps we have, even if their locale says differently, enables plugin authors to override the message timestamp formats in any way they choose, and addresses requests for complete dates in logs.

To recap, if you don't like the format string your locale has, enabled the "Message Timestamp Formats" plugin.


--- NEW FILE: log-signals.dox ---
/** @page log-signals Log Signals

 @signals
  @signal log-timestamp
 @endsignals

 <hr>

 @signaldef log-timestamp
  @signalproto
char *(*log_timestamp)(GaimConversation *conv, struct tm *tm);
  @endsignalproto
  @signaldesc
   Emitted to allow plugins to customize the timestamp on a message
   being logged.
  @param log The log the message belongs to.
  @param tm The time to be converted to a string.
  @return A textual representation of the time, or @c NULL to use a
          default format.
  @note Plugins must be careful of logs with a type of GAIM_LOG_SYSTEM.
 @endsignaldef

*/
// vim: syntax=c tw=75 et

Index: Makefile.am
===================================================================
RCS file: /cvsroot/gaim/gaim/doc/Makefile.am,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -d -p -r1.27 -r1.28
--- Makefile.am	8 Dec 2005 02:59:44 -0000	1.27
+++ Makefile.am	5 Jan 2006 20:17:34 -0000	1.28
@@ -20,6 +20,7 @@ EXTRA_DIST = \
 	gtkconv-signals.dox \
 	gtkimhtml-signals.dox \
 	gtkrc-2.0 \
+	log-signals.dox \
 	notify-signals.dox \
 	plugin-ids.dox \
 	plugin-signals.dox \

Index: gtkconv-signals.dox
===================================================================
RCS file: /cvsroot/gaim/gaim/doc/gtkconv-signals.dox,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -p -r1.4 -r1.5
--- gtkconv-signals.dox	23 Dec 2005 05:13:52 -0000	1.4
+++ gtkconv-signals.dox	5 Jan 2006 20:17:35 -0000	1.5
@@ -2,6 +2,7 @@
 
  @signals
   @signal conversation-dragging
+  @signal conversation-timestamp
   @signal displaying-im-msg
   @signal displayed-im-msg
   @signal displaying-chat-msg
@@ -21,6 +22,19 @@ void (*conversation_dragging)(GaimGtkWin
   @param destination The window where the conversation will be moved to.
  @endsignaldef
 
+ @signaldef conversation-timestamp
+  @signalproto
+char *(*conversation_timestamp)(GaimConversation *conv, struct tm *tm);
+  @endsignalproto
+  @signaldesc
+   Emitted to allow plugins to customize the timestamp on a message.
+  @param conv The conversation the message belongs to.
+  @param tm The time to be converted to a string.
+  @return A textual representation of the time, or @c NULL to use a
+          default format.
+ @endsignaldef
+
+
  @signaldef displaying-im-msg
   @signalproto
 gboolean (*displaying_im_msg)(GaimAccount *account, GaimConversation *conv,