Mercurial > pidgin

view doc/sound-signals.dox @ 28710:fed4286634e7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
propagate from branch 'im.pidgin.pidgin' (head d2984fa9ffdaa63b01cc1e0d94aec5622cd080c1) to branch 'im.pidgin.cpw.darkrain42.xmpp.scram' (head a046e925c84f1af65cc0bf41cc8ce55ba7ff3213)
author Paul Aurich <paul@darkrain42.org>
date Tue, 17 Nov 2009 19:23:05 +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