view doc/sound-signals.dox @ 14716:023dfc2ce5e3

[gaim-migrate @ 17470] Apparently a bunch of Ubuntu users weren't bothering to look at the configuration options for this plugin and were filing bugs about the window continuing to flash after being clicked on. This should help fix that. committer: Tailor Script <tailor@pidgin.im>
author Etan Reisner <pidgin@unreliablesource.net>
date Thu, 12 Oct 2006 13:42:11 +0000
parents b0582839cd6c
children 8cf53d7a0887
line wrap: on
line source

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