view doc/sound-signals.dox @ 26793:aa28018bfa17

propagate from branch 'im.pidgin.pidgin' (head 0a225b2db14919b2e455f6938d28c885d6ca74e4) to branch 'im.pidgin.cpw.darkrain42.xmpp.avatars' (head 640f790180ffe11e0cca24d096f4cc182f0e0d53)
author Paul Aurich <paul@darkrain42.org>
date Mon, 27 Apr 2009 06:14:25 +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