view doc/sound-signals.dox @ 20317:ac46ffeb5b2b

applied changes from 6b5f1f48667171fe73de619dd8f80cacd231a2e2 through d50ecf4dc52f25cbd219d6c19846436dec5a8853
author Luke Schierer <lschiere@pidgin.im>
date Fri, 19 Oct 2007 17:40:29 +0000
parents 1414e0e01dc5
children e0613cf8c493
line wrap: on
line source

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 <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 tw=75 et