view doc/sound-signals.dox @ 21666:d804f5b656cd

merge of '58c35aec5c3cdd46ab59070b5e659782d73d8001' and 'ee39fe2d2bc694cf58bd99f447589b8e19da8c66'
author Ethan Blanton <elb@pidgin.im>
date Tue, 27 Nov 2007 15:57:03 +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