Mercurial > pidgin.yaz

view doc/sound-signals.dox @ 29399:a8e19b69e6b4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Might as well make this comment accurate.
author Paul Aurich <paul@darkrain42.org>
date Wed, 10 Feb 2010 04:01: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