doc/imgstore-signals.dox

Wed, 19 Sep 2007 11:39:42 +0000

author
Will Thompson <resiak@pidgin.im>
date
Wed, 19 Sep 2007 11:39:42 +0000
branch
cpw.resiak.disconnectreason
changeset 20442
97e2d532c2ac
parent 16740
c95b1a276ea1
child 20897
2608e9e07913
permissions
-rw-r--r--

Clarified the meaning of PURPLE_REASON_NETWORK_ERROR and
PURPLE_REASON_AUTHENTICATION_FAILED, and added
PURPLE_REASON_AUTHENTICATION_IMPOSSIBLE. It's not fatal basically because none
of the places in prpl-jabber that need it set wants_to_die --- should it be?

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