view doc/sound-signals.dox @ 30601:fc8f98d1e81f

merge of '2e94598029dc6350d656fd335ad83738ff0c8e29' and '5e3707fd727a9e7f1d26a84dbf06be284072fd1f'
author Marcus Lundblad <ml@update.uu.se>
date Thu, 10 Jun 2010 20:35:08 +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