view doc/imgstore-signals.dox @ 20643:cb7d809867ac

propagate from branch 'im.pidgin.pidgin' (head b2924d43f1e1cb2d01705932d9a06df6eedf7ac0) to branch 'im.pidgin.sadrul.currentmedia' (head 15698906f0fff90b76df130d6cebe3f183c2cfaf)

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