view doc/sound-signals.dox @ 24427:5950e7a32c4f

merge of '12d71b833c7d3451c58c50e6dc621a88d678d474' and '42f888b4f8e15a19002abe6f40a5d89117ee59a7'
author Richard Laager <rlaager@wiktel.com>
date Fri, 14 Nov 2008 07:41:10 +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