view doc/imgstore-signals.dox @ 25173:ee5f4c2a177a

propagate from branch 'im.pidgin.pidgin' (head ff33fd0d52d8b32701b296048df6105a5c70e554) to branch 'org.darkrain42.pidgin.xmpp' (head 6c71380c5a07f5c274b8353f8c64c23fd900d12b)

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