view doc/sound-signals.dox @ 21098:7e200a629109

explicit merge of '8f24e3576448fefbc861e06f1e8d5fe17db2e71a' and '49d0219884ede2c6c571f2df73e29dffa86f54ad'
author Richard Laager <rlaager@wiktel.com>
date Sun, 14 Oct 2007 02:13:14 +0000
parents e0613cf8c493
children
line wrap: on
line source

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 @see sound.h

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