view doc/imgstore-signals.dox @ 20278:92d14ab89e6e

applied changes from 99f8d517ae6588b2dba3527cb0951f32e640ff57 through c96ba4911be2d71dc65eafb95c21c387e3d05210
author Evan Schoenberg <evan.s@dreskin.net>
date Sat, 29 Sep 2007 04:33:19 +0000
parents 61ddeb85ab86
children e0613cf8c493
line wrap: on
line source

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