Mercurial > pidgin.yaz

view doc/sound-signals.dox @ 20807:e0613cf8c493

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add some links from signal documentation back to the documentation for the corresponding header. Also, if there are going to be vim modelines with "syntax" settings, they may as well be "c.doxygen" not "c".
author Will Thompson <will.thompson@collabora.co.uk>
date Sun, 07 Oct 2007 18:49:50 +0000
parents 1414e0e01dc5
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