view doc/sound-signals.dox @ 16815:9410f6c2c542

merge of '45d1b5cb6bcf0cce3082b5b48045a5b708ed27d5' and 'e3290844f738f1d63f421385f00eb7e013344e70'
author Mark Doliner <mark@kingant.net>
date Thu, 03 May 2007 07:48:32 +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