view doc/sound-signals.dox @ 20147:51457cf3d27b

merge of '0fb234fbd6f0cbba882df8df649a783fea7f312f' and '43e06ba1c67cc326d2d93f14d67709b2375da88b'
author Casey Harkins <charkins@pidgin.im>
date Tue, 18 Sep 2007 01:02:55 +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