view doc/sound-signals.dox @ 20280:f00ab6c3d6d6

merge of 'd80b73af2a76c9ef004532af875209973de125b5' and 'dae4542eb3eed2f6c9e8910ad38ae01f92631192'
author Evan Schoenberg <evan.s@dreskin.net>
date Sat, 29 Sep 2007 13:32:05 +0000
parents 1414e0e01dc5
children e0613cf8c493
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)(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