view doc/sound-signals.dox @ 20577:23a448e8ff79

merge of '6cb0c90b1044b61c7a2c1a7d78c55ef4c5af2bfb' and 'd2626362a5e64d2cf82ee28b9f6383627e2db635'
author Will Thompson <will.thompson@collabora.co.uk>
date Thu, 20 Sep 2007 16:32:45 +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