Mercurial > pidgin

view doc/sound-signals.dox @ 29290:4c465be6c39c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
propagate from branch 'im.pidgin.pidgin' (head 191873f724e4551edc337f1e018980f32c41391b) to branch 'im.pidgin.cpw.attention_ui' (head a02a9ae52657550da4f2c4bf1f5131c9b84a31c5)
author Marcus Lundblad <ml@update.uu.se>
date Wed, 13 May 2009 20:38:38 +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