view doc/sound-signals.dox @ 32366:ae0fa8a95fd9

We haven't used this pref in a while. We stopped adding it in revision 106592f58365ca74fb7446ca751df08904021b9d. We also need to stop trying to rename it, and we should remove it if it exists. For 3.0.0 we should go through the prefs that we're migrating and removing and stop migrating/removing them if we've been doing it since before 2.0.0.

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