view doc/sound-signals.dox @ 22431:49976f4b5005

merge of '83a8dbf04d73ded7b026f8b63a26f5656d8fb25b' and 'ad54253e8a27e07bd353bd4353692d0f765b5b98'
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Sat, 08 Mar 2008 01:07:04 +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