Mercurial > pidgin

view doc/sound-signals.dox @ 23495:0fc1d2df836e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
propagate from branch 'im.pidgin.pidgin' (head 5e9671c654b021e77695d4a863fb55e27a831901) to branch 'im.pidgin.cpw.qulogic.msn' (head b062f14d1bcd8e6c28b2b05977aa19a4bfd4867c)
author Elliott Sales de Andrade <qulogic@pidgin.im>
date Sat, 21 Jun 2008 07:36:16 +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