view doc/sound-signals.dox @ 24303:ca7b726c8831

merge of '8ed01adf0c9173501da81537854ce2954e9805e7' and 'd5e8d63bd0bb69016447e0b053ea96ead0f57504'
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Sat, 01 Nov 2008 19:07:22 +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