view doc/imgstore-signals.dox @ 29628:e77894113a14

propagate from branch 'im.pidgin.pidgin' (head 122c09fb418ceb629bb942da06d3a45a22f19680) to branch 'im.pidgin.pidgin.next.minor' (head d47e94f98ed0b6e0a095e1f7c55cffb5a862316b)

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