changeset 11022:4febc4df0eb8

[gaim-migrate @ 12893] sf patch #1223463, from Richard Laager Documentation! Can you believe it? Need I remind you that this is an open source project? committer: Tailor Script <tailor@pidgin.im>
author Mark Doliner <mark@kingant.net>
date Wed, 22 Jun 2005 23:10:58 +0000
parents dd5c802baf7b
children 9a99b0815459
files doc/Makefile.am doc/buddyicon-signals.dox plugins/ChangeLog.API
diffstat 3 files changed, 27 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/Makefile.am	Wed Jun 22 23:03:07 2005 +0000
+++ b/doc/Makefile.am	Wed Jun 22 23:10:58 2005 +0000
@@ -10,6 +10,7 @@
 	TCL-HOWTO.dox \
 	account-signals.dox \
 	blist-signals.dox \
+	buddyicon-signals.dox \
 	connection-signals.dox \
 	conversation-signals.dox \
 	gtkaccount-signals.dox \
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/buddyicon-signals.dox	Wed Jun 22 23:10:58 2005 +0000
@@ -0,0 +1,24 @@
+/** @page buddyicon-signals Buddy Icon Signals
+
+ @signals
+  @signal buddy-icon-cached
+ @endsignals
+
+ <hr>
+
+ @signaldef buddy-icon-cached
+  @signalproto
+void (*buddy-icon-cached)(GaimBuddyIcon *icon, GaimBuddy *buddy, const char *filename, const char *old_icon);
+  @endsignalproto
+  @signaldesc
+   Emitted when a buddy icon is cached.
+  @param icon     The icon that was just cached.
+  @param buddy    The buddy the icon belongs to.
+  @param filename The full filename for the newly created icon cache file.
+  @param old_icon The filename of the icon cache file for the buddy's previous icon, or @c NULL if the buddy
+                  had no icon when this new icon was set. This filename is generally the full filename of the
+                  previous icon cache file, but if the previous buddy icon was set in an old version of Gaim,
+                  this may just be the basename of the icon cache file. The directory can be obtained with
+                  gaim_buddy_icons_get_cache_dir().
+ @endsignaldef
+*/
--- a/plugins/ChangeLog.API	Wed Jun 22 23:03:07 2005 +0000
+++ b/plugins/ChangeLog.API	Wed Jun 22 23:10:58 2005 +0000
@@ -74,6 +74,8 @@
 	           last handler was used.
 	* Changed: gaim_conv_window_remove_conversation()'s last argument to
 	           be a GaimConversation.
+	* Added:   "buddy-icon-cached", which is called when a new buddy icon
+	           is cached.
 
 version 1.0.0 (09/17/2004):
 	* Added: get_chat_name to the GaimPluginProtocolInfo struct