view doc/sound-signals.dox @ 26135:91a7d0ad2021

propagate from branch 'im.pidgin.pidgin' (head d2e4560619da68f5b4346dcf1247908d88f39eb3) to branch 'im.pidgin.soc.2008.yahoo' (head 9a753e6b9d2389b3b7a87d60eebbe98228c2fb36)
author Sulabh Mahajan <sulabh@soc.pidgin.im>
date Sun, 13 Jul 2008 14:19:59 +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