view doc/imgstore-signals.dox @ 20474:416ce8a7ac66

merge of '5d965caa0ea003eef5a1b959791135f900bf10ea' and 'b41b57944b61fe6aa3f27f7d98376ce73ed181c3'
author Ka-Hing Cheung <khc@hxbc.us>
date Sat, 21 Jul 2007 23:56:57 +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