view doc/sound-signals.dox @ 20252:9752389df732

applied changes from dc2a169f471dfdbf1c4d38b456a597f7b03c10ce through ef4d235da129a17dce0586517cda29e19d992e84
author Richard Laager <rlaager@wiktel.com>
date Fri, 28 Sep 2007 16:23:19 +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