view doc/sound-signals.dox @ 20497:89a82874d64e

merge of '85c73f22a9f7e979b53ff5d0d965a8cba49b35c0' and 'b72032dfc24c2067d0692d367120edaa068a1f7c'
author Ka-Hing Cheung <khc@hxbc.us>
date Sat, 08 Sep 2007 23:59:25 +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