view doc/sound-signals.dox @ 24454:1ee0ded8926b

merge of '27bbe0ce3ea70a4a4f830cb5f63e86c8ed26baca' and '8157f4ff83aedc353de32b5b1762738f167b6971'
author John Bailey <rekkanoryo@rekkanoryo.org>
date Mon, 24 Nov 2008 00:52:41 +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