view doc/sound-signals.dox @ 16467:b2044e10915a

merge of 'ca40214f7a10f0e15d7bd32bed84b177889ca02d' and 'dfafb91b749752416047f800169f9c839c909733'
author Daniel Atallah <daniel.atallah@gmail.com>
date Fri, 27 Apr 2007 00:28: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