view doc/sound-signals.dox @ 24211:de3e32bb942a

merge of '014e1f90f8ee8c07fa6d5bef545016ecfafda630' and '7d61237e0ffb6113b3c1286311b584034a870b19'
author Marcus Lundblad <ml@update.uu.se>
date Sun, 19 Oct 2008 21:46:38 +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