view doc/sound-signals.dox @ 28928:61e2537722e0

merge of '6e11e232a469bd7bd1f5c8dadebcfa5809eb1cd1' and 'e200d014d204272dbca9f1f87a8192b0c3e85ef3'
author Marcus Lundblad <ml@update.uu.se>
date Mon, 01 Feb 2010 21:28:33 +0000
parents e0613cf8c493
children
line wrap: on
line source

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 @see sound.h

 <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.doxygen tw=75 et