view doc/imgstore-signals.dox @ 19582:d4fb44035799

merge of '1bc4d7f1a38917e6d2bf837a660f5f498a29ea0c' and 'dd0060c3e748fd6d877ca32879c785c9bdb434fc'
author Ka-Hing Cheung <khc@hxbc.us>
date Mon, 03 Sep 2007 02:19:23 +0000
parents 61ddeb85ab86
children e0613cf8c493
line wrap: on
line source

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