annotate doc/gtklog-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 (2011-03-31)
parents e0613cf8c493
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12838
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
1 /** @page gtklog-signals GtkLog Signals
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
2
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
3 @signals
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
4 @signal log-displaying
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
5 @endsignals
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
6
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16183
diff changeset
7 @see gtklog.h
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16183
diff changeset
8
12838
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
9 <hr>
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
10
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
11 @signaldef log-displaying
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
12 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12838
diff changeset
13 void (*log_displaying)(PidginLogViewer *viewer, PurpleLog *log);
12838
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
14 @endsignalproto
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
15 @signaldesc
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
16 Emitted when a log is being displayed.
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
17 @param viewer The log viewer
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
18 @param log The log being displayed
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
19 @endsignaldef
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
20
cb36bc2db7c5 [gaim-migrate @ 15186]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
21 */
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16183
diff changeset
22 // vim: syntax=c.doxygen tw=75 et