view doc/imgstore-signals.dox @ 18619:0cb46c94c47d

merge of '5e94d4a46251e35e2b640180905fe364b82355e5' and 'de5a871fa6d3a03c03ddd957d08ad9773028f709'
author Ka-Hing Cheung <khc@hxbc.us>
date Mon, 23 Jul 2007 02:35:22 +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