Mercurial > pidgin

view doc/sound-signals.dox @ 31291:b9dc45392feb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
propagate from branch 'im.pidgin.pidgin' (head 665e2d641cdd2b6cca3bca378641f8345572146f) to branch 'im.pidgin.pidgin.mxit' (head 20a7b36a8dc242edd143675b69a3e2864a11afbe)
author pieter.loubser@mxit.com
date Wed, 15 Sep 2010 08:28:39 +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