view doc/imgstore-signals.dox @ 24335:0b6acb534f16

merge of '62e0eb23e1c2cd6ac1d8a7d96b6e598bd54ed0d2' and 'c8e0fdc8a85e96e382b7f826cfebfb1f54dcf12b'
author John Bailey <rekkanoryo@rekkanoryo.org>
date Thu, 30 Oct 2008 03:58:20 +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