view doc/sound-signals.dox @ 29129:ebb424b7e0a1

merge of '0bd5c5d235ae8c70b289e3b55a19523c4e28539e' and '9ba62902a7be15503ccd0006cd59c73fecc6255c'
author Mark Doliner <mark@kingant.net>
date Thu, 03 Dec 2009 08:02:54 +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