view doc/sound-signals.dox @ 18152:af0b9c6cbeb8

merge of 'a044da71f197bdd564f0d38ebb02798e06d1997f' and 'e64c6a26887b59ce7ad568ea1c551938e673c7a0'
author Nathan Walp <nwalp@pidgin.im>
date Sun, 17 Jun 2007 05:09:21 +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