view doc/sound-signals.dox @ 18619:0cb46c94c47d

merge of '5e94d4a46251e35e2b640180905fe364b82355e5' and 'de5a871fa6d3a03c03ddd957d08ad9773028f709'
author Ka-Hing Cheung <khc@hxbc.us>
date Mon, 23 Jul 2007 02:35:22 +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