view doc/imgstore-signals.dox @ 20470:7d6f247f08d9

propagate from branch 'im.pidgin.pidgin' (head be582d1ac8a250870b9c691a8cb1ab4c170650bc) to branch 'im.pidgin.cpw.khc.msnp14' (head 02e228232108b82dfaf51b2bd5daabeab692c0b0)

/** @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