view doc/sound-signals.dox @ 32031:02ece73986f5

merge of 'd09f79ede5d30c1f516d4af546eb9a0f1d052593' and 'f6f1584f72ad1c5035410dc939f2251e873b5d54'
author Mark Doliner <mark@kingant.net>
date Mon, 09 May 2011 08:34:25 +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