view doc/imgstore-signals.dox @ 19560:50377bbd1430

Document the attention API added in 5ac064e7e9268acbd8f76b4dd35350e38ca2bad9 and revised in bb439d33c8e6728e2dbf315476c20420b108297a and df9bdc703329b5f1f7a55ab861db020eee019134.
author Jeffrey Connelly <jaconnel@calpoly.edu>
date Thu, 30 Aug 2007 04:41: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