view doc/imgstore-signals.dox @ 29079:e0c20f0e04bc

propagate from branch 'im.pidgin.pidgin' (head 09828caa4a3333f2f0eed91315c29d5b3aa66fcb) to branch 'im.pidgin.pidgin.next.minor' (head ccf1c70ee84a00016887a8c9f790556a4c6fb6d5)
author John Bailey <rekkanoryo@rekkanoryo.org>
date Sat, 22 Aug 2009 03:59:35 +0000
parents e0613cf8c493
children
line wrap: on
line source

/** @page imgstore-signals Image Store Signals

 @signals
  @signal image-deleting
 @endsignals

 @see imgstore.h

 <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.doxygen tw=75 et