view doc/sound-signals.dox @ 14719:2e4690852fd7

[gaim-migrate @ 17473] Fix some whitespace, some mine from one of the back before I was a developer, and some I have no real idea how it happened. Also add my IRC nick to the manpage, it seems to be a common thing. committer: Tailor Script <tailor@pidgin.im>
author Etan Reisner <pidgin@unreliablesource.net>
date Fri, 13 Oct 2006 00:26:54 +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