view doc/sound-signals.dox @ 24335:0b6acb534f16

merge of '62e0eb23e1c2cd6ac1d8a7d96b6e598bd54ed0d2' and 'c8e0fdc8a85e96e382b7f826cfebfb1f54dcf12b'
author John Bailey <rekkanoryo@rekkanoryo.org>
date Thu, 30 Oct 2008 03:58: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