view doc/sound-signals.dox @ 19661:aa3920f45ff3

merge of '906281124efc7c5fcab1d5a7b8066c6a99d7927d' and '9d3e08ca8d3c17d78b9671fdffc4a0769a0a1495'
author Kevin Stange <kevin@simguy.net>
date Thu, 06 Sep 2007 06:59:23 +0000
parents 1414e0e01dc5
children e0613cf8c493
line wrap: on
line source

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 <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 tw=75 et