view doc/sound-signals.dox @ 30522:0f6ef3b21e17

merge of '4e5f78559deacc45eb458cdbe7ffc96491ab11bd' and '97f70a97fe41a0319d0041706ffaf3a6e4f0367d'
author Marcus Lundblad <ml@update.uu.se>
date Sun, 14 Feb 2010 22:42:20 +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