view doc/sound-signals.dox @ 22890:48e33e3673e2

propagate from branch 'im.pidgin.pidgin' (head 42df8ef15f4603d876ab1d764ffb91b9fc071840) to branch 'im.pidgin.pidgin.custom_smiley' (head f78bb7f531a4f3868b35c70ede0cd791f4a23dac)
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Tue, 18 Mar 2008 00:48:33 +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