view doc/sound-signals.dox @ 32145:855a539dcec7

applied changes from aebefd6d98382ce0f7b42b41e4bf2611044d4182 through 85da0d7a218eb1ea8d50919d292c9fe369131168 Original commit message: Mention the gevolution compile fix in the changelog
author Mark Doliner <mark@kingant.net>
date Mon, 20 Jun 2011 05:31:28 +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