view doc/sound-signals.dox @ 17550:ef3f817cac91

merge of '73a92318a135ab11655ab5e68f5b079e16d72075' and 'e8e7793a2f8c520976c6e1f1cffe1c30697f44bf'
author Nathan Walp <nwalp@pidgin.im>
date Fri, 08 Jun 2007 12:52:35 +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