view doc/sound-signals.dox @ 17183:840b0730b3c2

merge of '62e9d17cd37551991c5040ce6ca48e6d7578dde3' and '66d638c8f40814be99a7eddd8ca3cc474fafffc9'
author Etan Reisner <pidgin@unreliablesource.net>
date Sun, 20 May 2007 05:50:15 +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