view doc/sound-signals.dox @ 22504:a65a76072f31

merge of '058ee765cda4210b0bbd2e709b93a6e8bd956b21' and 'ff7de32106917f9d86c4f37b364c0fecd453c2ed'
author Stu Tomlinson <stu@nosnilmot.com>
date Mon, 17 Mar 2008 14:43:28 +0000
parents e0613cf8c493
children
line wrap: on
line source

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