doc/imgstore-signals.dox

Mon, 01 Oct 2007 17:44:04 +0000

author
Luke Schierer <lschiere@pidgin.im>
date
Mon, 01 Oct 2007 17:44:04 +0000
branch
release-2.2.1
changeset 20408
97e945cef795
parent 16740
c95b1a276ea1
child 20897
2608e9e07913
permissions
-rw-r--r--

merge of '392db9c2383dd6a8931565b8451179220d6cbbfc'
and '88c21e50426d7f139ecfdf059ebd108cdaa2d069'

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

mercurial