view doc/sound-signals.dox @ 16620:e9c412816e4e

merge of '88139d3c38c247fb0f892c9f42643f986ebf996e' and 'a35e9c6965a0723281ab3a62044581a55d2e59a2'
author Richard Laager <rlaager@wiktel.com>
date Sun, 29 Apr 2007 01:01:51 +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