view doc/sound-signals.dox @ 32060:67143ecbddb1

propagate from branch 'im.pidgin.pidgin' (head 9b3deec2188b0d6cd5015cc06c8de2f7d5696a59) to branch 'im.pidgin.soc.2009.webkitmessageview' (head f4f724d0d7a1a3cf374b8eff0a2ce1e07ab7fb41)
author tdrhq@soc.pidgin.im
date Mon, 27 Jul 2009 03:14:08 +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