view doc/sound-signals.dox @ 32161:a99a4f9b7171

merge of '2cabccedebb0366f69f7d3e9c3e16e2f4c6b3aae' and '964dd46e688370c356b8c9f20a929290f4a00e6d'
author Paul Aurich <paul@darkrain42.org>
date Sat, 25 Jun 2011 02:47:48 +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