view doc/sound-signals.dox @ 14514:bb99380c67c3

[gaim-migrate @ 17234] Install gaim-notifications-example in the bin directory instead of a docs directory. Is this a good idea? Maybe we shouldn't install it anywhere (and let rpms and dpkgs put it in the docs directory?) committer: Tailor Script <[e-mail]>

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 <hr>

 @signaldef playing-sound-event
  @signalproto
gboolean (*playing_sound_event)(GaimSoundEventID event, GaimAccount *account);
  @endsignalproto
  @signaldesc
   Emitted when gaim 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