view doc/log-signals.dox @ 13476:465c368366f8

[gaim-migrate @ 15852] Add GAIM_MESSAGE_ACTIVE_ONLY: This allows core plugins to hint to the UI that it should not show a message if a conversation is "inactive". For the GTK+ UI, this means conversations that aren't the active conversation in a contact-aware conversation. With the GTK+ UI, to avoid having such a message logged, you need to either call gaim_conv_im_write() (which will drop the message before logging, or allow it through for both logging and displaying) or set the GAIM_MESSAGE_NO_LOG flag (which obviously suppresses all logging). Look at the Buddy State Notification and Psychic plugins for the examples of each of these techniques, respectively. This fixes a ShowStopperBug. Also, rearrange some stuff in gtkconv.c to make things more clear and remove unused code. committer: Tailor Script <[e-mail]>

/** @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