view doc/sound-signals.dox @ 25811:88a66cb4a8d9

merge of '32cd8507d8b94418ca8f083d8555916341b47b94' and 'ca1b3ac908985d80ba2b86ef01bc4fcb4cf70fb7'
author Richard Laager <rlaager@wiktel.com>
date Sun, 02 Nov 2008 19:14:51 +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