view doc/sound-signals.dox @ 32781:9686216828f9

propagate from branch 'im.pidgin.soc.2012.gg' (head 7e7ded95fce2925f90c076c274edad16084b5032) to branch 'im.pidgin.pidgin' (head 79a577d0889f9db570dd39f03efd0605e9aba218)
author tomkiewicz@cpw.pidgin.im
date Fri, 25 May 2012 18:02:53 +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