view doc/sound-signals.dox @ 16362:7d0d3a746299

merge of '0ad153fbef57439d42601681df47200b190f5306' and '7bc42f0640ea8a9dce96dfc69f883523273e253d'
author Ethan Blanton <elb@pidgin.im>
date Wed, 25 Apr 2007 02:23:29 +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