# HG changeset patch
# User Richard Laager <rlaager@wiktel.com>
# Date 1177889644 0
# Node ID 61ddeb85ab8632873a4f37d0391ee36b1a673e05
# Parent  07b5cf0a46e220ebd042241782d0bd84c5257c0a
Document the image-deleting signal.

diff -r 07b5cf0a46e2 -r 61ddeb85ab86 doc/Makefile.am
--- a/doc/Makefile.am	Sun Apr 29 23:23:17 2007 +0000
+++ b/doc/Makefile.am	Sun Apr 29 23:34:04 2007 +0000
@@ -21,6 +21,7 @@
 	gtklog-signals.dox \
 	gtkimhtml-signals.dox \
 	gtkrc-2.0 \
+	imgstore-signals.dox \
 	log-signals.dox \
 	notify-signals.dox \
 	pidgin.1.in \
diff -r 07b5cf0a46e2 -r 61ddeb85ab86 doc/imgstore-signals.dox
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/imgstore-signals.dox	Sun Apr 29 23:34:04 2007 +0000
@@ -0,0 +1,24 @@
+/** @page imgstore-signals Image Store Signals
+
+ @signals
+  @signal image-deleting
+ @endsignals
+
+ <hr>
+
+ @signaldef image-deleting
+  @signalproto
+char *(*image_deleting)(const PurpleStoredImage *img);
+  @endsignalproto
+  @signaldesc
+   Emitted when a PurpleStoredImage is about to be destroyed.  This allows
+   for what amounts to weak references.  Code can hold onto a pointer to
+   the PurpleStoredImage without actually "holding" a reference.  They can
+   then use a signal handler to let them know when their img is about to
+   be destroyed.
+  @param img The image about to be destroyed.
+  @note It's not possible to purple_imgstore_ref() img to save it.
+ @endsignaldef
+
+*/
+// vim: syntax=c tw=75 et
diff -r 07b5cf0a46e2 -r 61ddeb85ab86 libpurple/buddyicon.c
--- a/libpurple/buddyicon.c	Sun Apr 29 23:23:17 2007 +0000
+++ b/libpurple/buddyicon.c	Sun Apr 29 23:34:04 2007 +0000
@@ -208,7 +208,7 @@
 }
 
 static void
-image_deleting_cb(PurpleStoredImage *img, gpointer data)
+image_deleting_cb(const PurpleStoredImage *img, gpointer data)
 {
 	const char *filename = purple_imgstore_get_filename(img);