view doc/imgstore-signals.dox @ 22891:43233dc1d40b

applied changes from 4c5110037671f84e3e775214c32692b5b23c11e1 through ae37fe6b64c30704715a369df88bd76674a39b1a applied changes from 4c5110037671f84e3e775214c32692b5b23c11e1 through ae37fe6b64c30704715a369df88bd76674a39b1a applied changes from b28057d6ade7c221b0616c3b02e86659e2d8b10b through 52c0efb045580dac7b6f5e40c91002e917e0cae3 Plucked changes for the chat-join-failed signal and associated server.c function from im.pidgin.pidgin, as these necessitate a minor version bump.

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