view doc/imgstore-signals.dox @ 26919:a6a4b440e5ae

merge of '53630753bb021f7391e8ad30abd709f73fe47c3d' and '90901b2c41b0b1a7856d9fb15fb2eb3b67383423'
author Paul Aurich <paul@darkrain42.org>
date Wed, 20 May 2009 00:39:12 +0000
parents e0613cf8c493
children
line wrap: on
line source

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