view doc/sound-signals.dox @ 28998:584ef95f0e77

merge of '033dd646e39f8913f23a1536f8ff18c0489a8432' and '8a8eea49a73487bb8550ba0ec70e444aaa6e2204'
author Mark Doliner <mark@kingant.net>
date Sun, 07 Feb 2010 17:43:30 +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