view doc/sound-signals.dox @ 23393:0a7fe6eaa5ab

propagate from branch 'im.pidgin.pidgin.2.4.3' (head c3831c9181f4f61b747321240086ee79e4a08fd8) to branch 'im.pidgin.pidgin' (head 56142fc8ab251185fb90236062737b3768d52710)
author Stu Tomlinson <stu@nosnilmot.com>
date Thu, 26 Jun 2008 19:05:27 +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