view doc/sound-signals.dox @ 17710:9e041b31ae96

merge of '17044aa63b0858da0a71332e152b5f3440fa5107' and '3d1e6b8637ff9133c8f17e9aeaeea1284c898d86'
author Nathan Walp <nwalp@pidgin.im>
date Mon, 04 Jun 2007 14:09:08 +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