doc/imgstore-signals.dox

Fri, 21 May 2010 21:57:18 +0000

author
Elliott Sales de Andrade <qulogic@pidgin.im>
date
Fri, 21 May 2010 21:57:18 +0000
changeset 30330
f858236de0f4
parent 20897
2608e9e07913
permissions
-rw-r--r--

merge of 'b88548117247cbed4a82522e7c69a28404341bb2'
and 'd2cb1662df796e8ac17ce26551a58380e1284b8a'

/** @page imgstore-signals Image Store Signals

 @signals
  @signal image-deleting
 @endsignals

 @see imgstore.h

 <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.doxygen tw=75 et

mercurial