view doc/sound-signals.dox @ 32005:135868ec0aa9

propagate from branch 'im.pidgin.pidgin' (head 8707e10aca1fa6ef13a2a00f24760fb2ed97f641) to branch 'im.pidgin.cpw.masca.p2p' (head 941c9038bb0859c618dd334ada00158485678d24)
author masca@cpw.pidgin.im
date Tue, 04 Jan 2011 04:06:36 +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