Mercurial > pidgin

view doc/sound-signals.dox @ 24946:46387cbfaf85

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
propagate from branch 'im.pidgin.pidgin' (head 0e036cef0f8a3bdfd1d7f7fc082edca43d3153df) to branch 'im.pidgin.maiku.vv' (head e27dec62113f7fa6c149e927bef4838231e7315a)
author Mike Ruprecht <maiku@soc.pidgin.im>
date Sun, 19 Oct 2008 04:59:51 +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