Mercurial > pidgin

view doc/sound-signals.dox @ 28073:fd2dd4039cb4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
merge of 'a89c814a0c81eeacde296ce6a2520f1bac083ba4' and 'b15f3e0335356e294b5b83fd8ad94b8f10cf76c2'
author Richard Laager <rlaager@wiktel.com>
date Sat, 22 Aug 2009 23:42:31 +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