view doc/sound-signals.dox @ 31781:ac43f26c7f61

merge of '269c6e29c67a1c066871499e76575d4700bf6744' and 'f456e895f18adad6c0e3178c99a73f6fbd439487'
author Ethan Blanton <elb@pidgin.im>
date Thu, 11 Aug 2011 14:44:44 +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