view doc/sound-signals.dox @ 32315:c2fa3a76a0be

Get rid fo purple_strlcpy and purple_strlcat. These are convenience functions that call g_strlcpy and g_strlcat. They're only mildly convenient, though. And only used in one place. The reason I don't like them is that I think it's easy to use them incorrectly. It's easy to use the functions and not realize that they use sizeof() to determine the size of the destination buffer. I think it's too easy to accidentally use these functions with a string on the heap (which wouldn't work correctly).

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 @see sound.h

 <hr>

 @signaldef playing-sound-event
  @signalproto
gboolean (*playing_sound_event)(PurpleSoundEventID event, PurpleAccount *account);
  @endsignalproto
  @signaldesc
   Emitted when libpurple is going to play a sound event. This can be used to cancel playing sound by returning TRUE.
  @param event   The event this sound represents.
  @param account The account the sound is being played for.
  @return @c TRUE if the sound should not be played, or @c FALSE otherwise.
 @endsignaldef

 */
// vim: syntax=c.doxygen tw=75 et