view doc/sound-signals.dox @ 19582:d4fb44035799

merge of '1bc4d7f1a38917e6d2bf837a660f5f498a29ea0c' and 'dd0060c3e748fd6d877ca32879c785c9bdb434fc'
author Ka-Hing Cheung <khc@hxbc.us>
date Mon, 03 Sep 2007 02:19:23 +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