view doc/sound-signals.dox @ 22936:c0fc992da040

merge of '7fd0d8c5830d11a8f34c0d2fa6a6290427b182c4' and 'cfa8bcce1dfa952cf5b50a0d15e1e15a63d1f120'
author Luke Schierer <lschiere@pidgin.im>
date Wed, 14 May 2008 11:57:02 +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