view doc/sound-signals.dox @ 21332:f96753f63587

merge of '73057ee4da2b6a1bb75ad46fec3e2df323aa3e42' and 'abf7980115f18c3930b0d377fe2ead98e0891d26'
author Stu Tomlinson <stu@nosnilmot.com>
date Sun, 11 Nov 2007 18:11:50 +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