annotate doc/plugin-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.

 1 /** @page plugin-signals Plugin Signals
 2 
 3  @signals
 4   @signal plugin-load
 5   @signal plugin-unload
 6  @endsignals
 7 
 8  @see plugin.h
 9 
10  <hr>
11 
12  @signaldef plugin-load
13   @signalproto
14 void (*plugin_load)(PurplePlugin *plugin);
15   @endsignalproto
16   @signaldesc
17    Emitted when a plugin is loaded.
18   @param plugin The plugin that was loaded.
19  @endsignaldef
20 
21  @signaldef plugin-unload
22   @signalproto
23 void (*plugin_unload)(PurplePlugin *plugin);
24   @endsignalproto
25   @signaldesc
26    Emitted when a plugin is unloaded.
27   @param plugin The plugin that was unloaded.
28  @endsignaldef
29 
30  */
31 // vim: syntax=c.doxygen tw=75 et