view doc/sound-signals.dox @ 21496:0df3d6b11d05

merge of '29c59c7fc04cdf75b2debfab42171f298f82c5fc' and 'd5c59d95a2f6dee5e7af2653c48c880594d8528a'
author Will Thompson <will.thompson@collabora.co.uk>
date Wed, 14 Nov 2007 12:16:30 +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