Mercurial > pidgin.yaz

view doc/sound-signals.dox @ 29656:558baf33197e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
propagate from branch 'im.pidgin.pidgin' (head 7399f80ea98924dbddd57be1e652ecbae89d3a8e) to branch 'im.pidgin.cpw.attention_ui' (head 59a01fefc852925a87d40736c747f639270c11be)
author Marcus Lundblad <ml@update.uu.se>
date Mon, 24 Nov 2008 22:13:44 +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