view doc/sound-signals.dox @ 22935:4798de46bf4a

merge of '994f8bdccfcf73a73924e593d2c398c8d416e5e9' and 'e1c49c9ec5c6869ed9813feccd8ee41d2ca40f35'
author Ka-Hing Cheung <khc@hxbc.us>
date Wed, 14 May 2008 04:58:36 +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