view doc/sound-signals.dox @ 29095:b641af9dfe2a

propagate from branch 'im.pidgin.pidgin' (head 7bed935cd3432470394f51f4fe6e7f915aed9145) to branch 'im.pidgin.pidgin.next.minor' (head f6497ab7d689433e64b9e835dcaecde3de68971f)
author John Bailey <rekkanoryo@rekkanoryo.org>
date Tue, 25 Aug 2009 03:59:01 +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