view doc/sound-signals.dox @ 16354:fea7c90a5067

merge of '5a49fd68be5cffec6a2aae0c0cc312c64f67138d' and '7ad881ace36dfe2627b52ea8a93205957c05d77f'
author Kevin Stange <kevin@simguy.net>
date Tue, 24 Apr 2007 21:44:13 +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