Mercurial > pidgin

view doc/sound-signals.dox @ 16470:0fa041c66957

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
propagate from branch 'im.pidgin.pidgin' (head 4d02676110c034e401f4d42ed7304a7507d96929) to branch 'im.pidgin.rlaager.gaim_migration' (head cdf5792eae6b63870cd030ae85774d5385b7d428)
author Richard Laager <rlaager@wiktel.com>
date Wed, 25 Apr 2007 05:26:12 +0000
parents 1414e0e01dc5
children e0613cf8c493
line wrap: on
line source

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 <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 tw=75 et