view doc/sound-signals.dox @ 27060:08c6a0c88b2b

propagate from branch 'im.pidgin.pidgin' (head 505516826b01aed6390e0c2aa38706c0e2da163e) to branch 'im.pidgin.cpw.malu.client_type' (head 16f243728b922b28b331a8d06cfdcfe064a68f6b)
author Paul Aurich <paul@darkrain42.org>
date Sun, 07 Jun 2009 00:27: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