view doc/sound-signals.dox @ 16942:2d2c2913548b

merge of '6c5cdf9bfd5c1acf1c24c55338915947e844d91d' and 'b7ac78b8beb039f7545d74bbc3075947bb5d27e5'
author Richard Laager <rlaager@wiktel.com>
date Tue, 08 May 2007 03:38: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