view doc/imgstore-signals.dox @ 16744:a8e8482a2dc6

Clean up a few TODO's. 1) Update two old comments to reflect code. 2) Comment out escaping key and value in msim_send. 3) Add TODO for msim_send to support field types. 4) Update TODO for login2 command--'response' field must NOT be escaped. 5) Resolve TODO: add GUI options to change connect server and port.

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