view doc/sound-signals.dox @ 22970:06acaa3b765a

merge of '2f76f01c0ca7594f3efba9430e8de027252c3fd0' and '4543673d65f212baabcd1140a9f7394b033db0ec'
author Stu Tomlinson <stu@nosnilmot.com>
date Fri, 16 May 2008 03:02:31 +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