view doc/sound-signals.dox @ 32588:472e70ea58ed

propagate from branch 'im.pidgin.pidgin' (head 6f21535004485d16ec64ef6a7c331cf5df7346e6) to branch 'im.pidgin.cpw.masca.webkit' (head b89ab3856a07e9d3544d89c0e4c18653ebed9d1b)
author masca@cpw.pidgin.im
date Mon, 05 Sep 2011 02:14:18 +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