view doc/sound-signals.dox @ 16817:56823a55581a

Rework purple_buddy_icons_find() to return a reference for the caller, which is clearer and more consistent with other functions. Also, update purple_buddy_icons_set_for_user() to behave properly when called to clear an icon that isn't already in memory.

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

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