view doc/sound-signals.dox @ 20475:2a2cc0b57d8f

propagate from branch 'im.pidgin.pidgin' (head 5e94d4a46251e35e2b640180905fe364b82355e5) to branch 'im.pidgin.cpw.khc.msnp14' (head 7e42b1cb607bb785ef1a7d9e724f7d3ad0189f08)
author Ka-Hing Cheung <khc@hxbc.us>
date Sun, 22 Jul 2007 18:17:41 +0000
parents 1414e0e01dc5
children e0613cf8c493
line wrap: on
line source

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 <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 tw=75 et