view doc/sound-signals.dox @ 23945:60de5d1ee482

merge of '038d9d36d640ed83f9df5333d57dc0cd8b9ae847' and '9aeabc8056bc8b61f63881f3f6af2b2fcbd8b99c'
author Elliott Sales de Andrade <qulogic@pidgin.im>
date Thu, 21 Aug 2008 06:46:19 +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