view doc/sound-signals.dox @ 17260:c76bee45540a

propagate from branch 'im.pidgin.pidgin' (head dc4f2ee34039521ae6a198fe7d62f4dca8a84589) to branch 'im.pidgin.soc.2007.certmgr' (head 9a820d4262a69cde7e03915f22c234b75f54cf5c)
author William Ehlhardt <williamehlhardt@gmail.com>
date Fri, 25 May 2007 17:56:39 +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