view doc/sound-signals.dox @ 21319:85fbadb8b8fd

merge of '2fb075583d4e52527a1045112f38c7a76f2c7e80' and '69e2383bb3023269544a242c2538d711fd64d416'
author Will Thompson <will.thompson@collabora.co.uk>
date Sun, 11 Nov 2007 14:18:23 +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