view doc/imgstore-signals.dox @ 20101:3a5f152e7ed0

This fixes compilation issues where old glib and either an old gcc or a non-gcc compiler is used. I have opted to put the same preprocessor directives in each plugin over including additional headers to fix this for the purposes of staying as close as possible to the version I have in the how-to documentss on the wiki. Fixes #3142 and bugs reported via the mailing list, IRC channel, and XMPP conference.

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