view doc/sound-signals.dox @ 17468:c8ee24d443c6

merge of '158f2188a42dc47993ef8c4456fb084051cd485e' and '69f1848deb99093ace5393f554c3554be7f07735'
author William Ehlhardt <williamehlhardt@gmail.com>
date Wed, 30 May 2007 04:37:55 +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