view doc/sound-signals.dox @ 31808:2a02a59d1a12

propagate from branch 'im.pidgin.pidgin' (head 05feb74c1c6c8043bd8a617ae0f523fbc7a24cec) to branch 'im.pidgin.pidgin.next.minor' (head 9d0870f2cbcdb210b4fc16a08932de6afb264d83)
author Mark Doliner <mark@kingant.net>
date Thu, 08 Jul 2010 22:03:24 +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