doc/imgstore-signals.dox

   1 /** @page imgstore-signals Image Store Signals
   2
   3  @signals
   4   @signal image-deleting
   5  @endsignals
   6
   7  @see imgstore.h
   8
   9  <hr>
  10
  11  @signaldef image-deleting
  12   @signalproto
  13 char *(*image_deleting)(const PurpleStoredImage *img);
  14   @endsignalproto
  15   @signaldesc
  16    Emitted when a #PurpleStoredImage is about to be destroyed.  This allows
  17    for what amounts to weak references.  Code can hold onto a pointer to
  18    the PurpleStoredImage without actually "holding" a reference.  They can
  19    then use a signal handler to let them know when their img is about to
  20    be destroyed.
  21   @param img The image about to be destroyed.
  22   @note It's not possible to purple_imgstore_ref() img to save it.
  23  @endsignaldef
  24
  25 */
  26 // vim: syntax=c.doxygen tw=75 et