diff doc/conversation-signals.dox @ 31444:a9e077fb65e9

Add a cleared-message-history conversation signal, and use it in Pidgin and Finch This stems out of an email discussion with Andrew Victor back in July 2010 regarding letting protocol plugins clear the message scrollback area for UIs. At the time, nobody objected to having the libpurple-clearing function call the UI clearing function. This should also be happily backward-compatible.
author Paul Aurich <paul@darkrain42.org>
date Thu, 31 Mar 2011 04:41:27 +0000
parents e68d6c7990c1
children 02a2e8183b1d
line wrap: on
line diff
--- a/doc/conversation-signals.dox	Wed Mar 30 22:36:30 2011 +0000
+++ b/doc/conversation-signals.dox	Thu Mar 31 04:41:27 2011 +0000
@@ -32,6 +32,7 @@
   @signal chat-join-failed
   @signal chat-left
   @signal chat-topic-changed
+  @signal cleared-message-history
   @signal conversation-extended-menu
   @signal sent-attention
   @signal got-attention
@@ -479,6 +480,16 @@
   @since 2.1.0
  @endsignaldef
 
+ @signaldef cleared-message-history
+  @signalproto
+void (*cleared_message_history)(PurpleConversation *conv);
+  @endsignalproto
+  @signaldesc
+    Emitted when the conversation history is cleared.
+  @param conv   The conversation.
+  @since 2.8.0
+ @endsignaldef
+
  @signaldef sent-attention
   @signalproto
 void (*got_attention)(PurpleAccount *account, const char *who,